{"items":[{"type":"link","label":"Alerts","link":"/docs/inboxready/api-reference/optimize/inboxready","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready","content":{"contentType":"overview","meta":{"name":"Alerts"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"inboxready.json","url":"/_bundle/docs/inboxready/api-reference/optimize/inboxready.json?download"},{"kind":"download","label":"inboxready.yaml","url":"/_bundle/docs/inboxready/api-reference/optimize/inboxready.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Alerts (0.0.1)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference."}],"sectionId":"/docs/inboxready/api-reference/optimize/inboxready"}],"sectionId":"/docs/inboxready/api-reference/optimize/inboxready"}]}]}},{"type":"separator","label":"Mailgun Optimize","content":null},{"type":"group","label":"Domains","link":"/docs/inboxready/api-reference/optimize/inboxready/domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domains","items":[{"label":"Returns Domains on Mailgun Optimize services","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domains/get-v1-inboxready-domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domains/get-v1-inboxready-domains","metadata":{"seo":{"title":"Returns Domains on Mailgun Optimize services","description":"Will return details on an Mailgun Optimize Domain. If no Domain is provided, then a list of all Mailgun Optimize Domains on an account will be returned."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-inboxready-domains","name":"Returns Domains on Mailgun Optimize services","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Returns Domains on Mailgun Optimize services","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Will return details on an Mailgun Optimize Domain. If no Domain is provided, then a list of all Mailgun Optimize Domains on an account will be returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_174","description":"Limit"},{"name":"domain","in":"query","schemaId":"schema_175","description":"Domain name"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1inboxready~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/inboxready/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_174"},{"name":"domain","in":"query","schemaId":"schema_175"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/inboxready/domains","href":"domains/get-v1-inboxready-domains","openApiOperationId":"GET-v1-inboxready-domains","summary":"Returns Domains on Mailgun Optimize services"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","exampleIds":["paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","exampleIds":["paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","exampleIds":["paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","exampleIds":["paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/get-v1-inboxready-domains"}],"panels":[]}]},"httpPath":"/v1/inboxready/domains"},{"label":"Add a single domain to an account","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domains/post-v1-inboxready-domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domains/post-v1-inboxready-domains","metadata":{"seo":{"title":"Add a single domain to an account","description":"Add a single domain to an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-inboxready-domains","name":"Add a single domain to an account","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1domains/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add a single domain to an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain","in":"query","schemaId":"schema_175","description":"Domain name","required":true}],"pointer":"/paths/~1v1~1inboxready~1domains/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/inboxready/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"domain","in":"query","required":true,"schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/inboxready/domains","href":"domains/post-v1-inboxready-domains","openApiOperationId":"POST-v1-inboxready-domains","summary":"Add a single domain to an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1domains/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/post-v1-inboxready-domains"}],"panels":[]}]},"httpPath":"/v1/inboxready/domains"},{"label":"Deletes a single domain from an account","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domains/delete-v1-inboxready-domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domains/delete-v1-inboxready-domains","metadata":{"seo":{"title":"Deletes a single domain from an account","description":"Deletes a single domain from an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-inboxready-domains","name":"Deletes a single domain from an account","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1domains/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Deletes a single domain from an account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain","in":"query","schemaId":"schema_175","description":"Domain name","required":true}],"pointer":"/paths/~1v1~1inboxready~1domains/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/inboxready/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"domain","in":"query","required":true,"schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/inboxready/domains","href":"domains/delete-v1-inboxready-domains","openApiOperationId":"DELETE-v1-inboxready-domains","summary":"Deletes a single domain from an account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1domains/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/delete-v1-inboxready-domains"}],"panels":[]}]},"httpPath":"/v1/inboxready/domains"},{"label":"Queues a domain to be processed for verification","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domains/put-v1-inboxready-domains-verify","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domains/put-v1-inboxready-domains-verify","metadata":{"seo":{"title":"Queues a domain to be processed for verification","description":"Queues a domain to be processed for verification"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-inboxready-domains-verify","name":"Queues a domain to be processed for verification","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1domains~1verify/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Queues a domain to be processed for verification","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"domain","in":"query","schemaId":"schema_175","description":"Domain name","required":true}],"pointer":"/paths/~1v1~1inboxready~1domains~1verify/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/inboxready/domains/verify","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"domain","in":"query","required":true,"schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","default"],"pointer":"/v1/inboxready/domains/verify","href":"domains/put-v1-inboxready-domains-verify","openApiOperationId":"PUT-v1-inboxready-domains-verify","summary":"Queues a domain to be processed for verification"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1domains~1verify/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","exampleIds":["paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domains/put-v1-inboxready-domains-verify"}],"panels":[]}]},"httpPath":"/v1/inboxready/domains/verify"}],"content":{"contentType":"group","meta":{"name":"Domains"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domains","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/inboxready/domains","summary":"Returns Domains on Mailgun Optimize services","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domains/get-v1-inboxready-domains","deprecated":false},{"title":"/v1/inboxready/domains","summary":"Add a single domain to an account","prefix":{"name":"post","color":"post"},"badges":[],"link":"/domains/post-v1-inboxready-domains","deprecated":false},{"title":"/v1/inboxready/domains","summary":"Deletes a single domain from an account","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/domains/delete-v1-inboxready-domains","deprecated":false},{"title":"/v1/inboxready/domains/verify","summary":"Queues a domain to be processed for verification","prefix":{"name":"put","color":"put"},"badges":[],"link":"/domains/put-v1-inboxready-domains-verify","deprecated":false}]}]}]}]}},{"type":"group","label":"DMARC Reports","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports","items":[{"label":"Retrieves the DMARC DNS records to be used for configuration","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-records-domain-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-records-domain-","metadata":{"seo":{"title":"Retrieves the DMARC DNS records to be used for configuration","description":"Retrieves the DMARC DNS records to be used for configuration"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-records-domain-","name":"Retrieves the DMARC DNS records to be used for configuration","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1records~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves the DMARC DNS records to be used for configuration","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"Fully qualified domain name","required":true,"example":"example.com"}],"pointer":"/paths/~1v1~1dmarc~1records~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/records/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"example.com","schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dmarc/records/{domain}","href":"dmarc-reports/get-v1-dmarc-records-domain-","openApiOperationId":"GET-v1-dmarc-records-domain-","summary":"Retrieves the DMARC DNS records to be used for configuration"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | The records for DMARC DNS Setup"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1dmarc~1records~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-records-domain-"}],"panels":[]}]},"httpPath":"/v1/dmarc/records/{domain}"},{"label":"Checks if DMARC has been setup for user","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-setup-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-setup-","metadata":{"seo":{"title":"Checks if DMARC has been setup for user","description":"Checks if DMARC has been setup for user"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-setup-","name":"Checks if DMARC has been setup for user","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1setup/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Checks if DMARC has been setup for user","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/setup","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dmarc/setup","href":"dmarc-reports/get-v1-dmarc-setup-","openApiOperationId":"GET-v1-dmarc-setup-","summary":"Checks if DMARC has been setup for user"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Setup metadata for DMARC"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1dmarc~1setup/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-setup-"}],"panels":[]}]},"httpPath":"/v1/dmarc/setup"},{"label":"Gets referral link to redsift","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/post-v1-dmarc-referral-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/post-v1-dmarc-referral-","metadata":{"seo":{"title":"Gets referral link to redsift","description":"Gets referral link to redsift"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-dmarc-referral-","name":"Gets referral link to redsift","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1referral/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Gets referral link to redsift","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DMARC_Reports_ReferReq"}},"schemaId":"components/schemas/DMARC_Reports_ReferReq","pointer":"/paths/~1v1~1dmarc~1referral/post/requestBody","description":"Request for referral Link"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/dmarc/referral","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/DMARC_Reports_ReferReq"}},"responseCodes":["200"],"pointer":"/v1/dmarc/referral","href":"dmarc-reports/post-v1-dmarc-referral-","openApiOperationId":"POST-v1-dmarc-referral-","summary":"Gets referral link to redsift"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/DMARC_Reports_ReferReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/DMARC_Reports_ReferReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Referral Link to Redsift"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1dmarc~1referral/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/post-v1-dmarc-referral-"}],"panels":[]}]},"httpPath":"/v1/dmarc/referral"},{"label":"Retrieves the list of domains that have DMARC monitoring.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-","metadata":{"seo":{"title":"Retrieves the list of domains that have DMARC monitoring.","description":"Retrieves the list of domains that have DMARC monitoring."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-domains-","name":"Retrieves the list of domains that have DMARC monitoring.","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieves the list of domains that have DMARC monitoring.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_174","description":"UNIX epoch (UTC seconds) representing the start of the time range.","example":1736790000},{"name":"to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIX epoch (UTC seconds) representing the end of the time range. If supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set."},"children":[]}]}]}],"example":1736790285}],"pointer":"/paths/~1v1~1dmarc~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"from","in":"query","required":false,"example":1736790000,"schemaId":"schema_174"},{"name":"to","in":"query","required":false,"example":1736790285,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v1/dmarc/domains","href":"dmarc-reports/get-v1-dmarc-domains-","openApiOperationId":"GET-v1-dmarc-domains-","summary":"Retrieves the list of domains that have DMARC monitoring."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Object representing a list of DMARC monitored domains"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example"]}],"pointer":"/paths/~1v1~1dmarc~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-domains-"}],"panels":[]}]},"httpPath":"/v1/dmarc/domains"},{"label":"Retrieve DMARC reporting data for a domain.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-","metadata":{"seo":{"title":"Retrieve DMARC reporting data for a domain.","description":"Retrieve DMARC reporting data for a domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-domains-domain-","name":"Retrieve DMARC reporting data for a domain.","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DMARC reporting data for a domain.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"Fully qualified domain name","required":true,"example":"example.com"}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_174","description":"UNIX epoch (UTC seconds) representing the start of the time range.","example":1736790000},{"name":"to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIX epoch (UTC seconds) representing the end of the time range. If supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set."},"children":[]}]}]}],"example":1736790285}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/domains/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"example.com","schemaId":"schema_175"}],"query":[{"name":"from","in":"query","required":false,"example":1736790000,"schemaId":"schema_174"},{"name":"to","in":"query","required":false,"example":1736790285,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/dmarc/domains/{domain}","href":"dmarc-reports/get-v1-dmarc-domains-domain-","openApiOperationId":"GET-v1-dmarc-domains-domain-","summary":"Retrieve DMARC reporting data for a domain."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Object representing a DMARC monitored domain"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found | Domain not managed by this account"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-domains-domain-"}],"panels":[]}]},"httpPath":"/v1/dmarc/domains/{domain}"},{"label":"Retrieve DMARC reporting data from a specific source.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-","metadata":{"seo":{"title":"Retrieve DMARC reporting data from a specific source.","description":"Retrieve DMARC reporting data from a specific source."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-domains-domain-s-source-","name":"Retrieve DMARC reporting data from a specific source.","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DMARC reporting data from a specific source.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"Fully qualified domain name","required":true,"example":"example.com"},{"name":"source","in":"path","schemaId":"schema_175","description":"User friendly source id name","required":true,"example":"mailgun"}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_174","description":"UNIX epoch (UTC seconds) representing the start of the time range.","example":1736790000},{"name":"to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIX epoch (UTC seconds) representing the end of the time range. If supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set."},"children":[]}]}]}],"example":1736790285}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/domains/{domain}/s/{source}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"example.com","schemaId":"schema_175"},{"name":"source","in":"path","required":true,"example":"mailgun","schemaId":"schema_175"}],"query":[{"name":"from","in":"query","required":false,"example":1736790000,"schemaId":"schema_174"},{"name":"to","in":"query","required":false,"example":1736790285,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/dmarc/domains/{domain}/s/{source}","href":"dmarc-reports/get-v1-dmarc-domains-domain-s-source-","openApiOperationId":"GET-v1-dmarc-domains-domain-s-source-","summary":"Retrieve DMARC reporting data from a specific source."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Object representing DMARC info for a source"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found | Source related to domain not found"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-"}],"panels":[]}]},"httpPath":"/v1/dmarc/domains/{domain}/s/{source}"},{"label":"Retrieve DMARC reporting data for a hostname.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-","metadata":{"seo":{"title":"Retrieve DMARC reporting data for a hostname.","description":"Retrieve DMARC reporting data for a hostname."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-domains-domain-s-source-h-host-","name":"Retrieve DMARC reporting data for a hostname.","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DMARC reporting data for a hostname.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"Fully qualified domain name","required":true,"example":"example.com"},{"name":"source","in":"path","schemaId":"schema_175","description":"User friendly source id name","required":true,"example":"mailgun"},{"name":"host","in":"path","schemaId":"schema_175","description":"Host name","required":true,"example":"mx.mailgun.com"}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_174","description":"UNIX epoch (UTC seconds) representing the start of the time range.","example":1736790000},{"name":"to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIX epoch (UTC seconds) representing the end of the time range. If supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set."},"children":[]}]}]}],"example":1736790285}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"example.com","schemaId":"schema_175"},{"name":"source","in":"path","required":true,"example":"mailgun","schemaId":"schema_175"},{"name":"host","in":"path","required":true,"example":"mx.mailgun.com","schemaId":"schema_175"}],"query":[{"name":"from","in":"query","required":false,"example":1736790000,"schemaId":"schema_174"},{"name":"to","in":"query","required":false,"example":1736790285,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}","href":"dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-","openApiOperationId":"GET-v1-dmarc-domains-domain-s-source-h-host-","summary":"Retrieve DMARC reporting data for a hostname."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Object representing DMARC info for a hostname"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found | Host related to source not found"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-"}],"panels":[]}]},"httpPath":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}"},{"label":"Retrieve DMARC reporting data for an IP Address.","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","metadata":{"seo":{"title":"Retrieve DMARC reporting data for an IP Address.","description":"Retrieve DMARC reporting data for an IP Address."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","name":"Retrieve DMARC reporting data for an IP Address.","isWebhook":false,"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Retrieve DMARC reporting data for an IP Address.","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"Fully qualified domain name","required":true,"example":"example.com"},{"name":"source","in":"path","schemaId":"schema_175","description":"User friendly source id name","required":true,"example":"mailgun"},{"name":"host","in":"path","schemaId":"schema_175","description":"Host name","required":true,"example":"mx.mailgun.com"},{"name":"ip","in":"path","schemaId":"schema_175","description":"a valid IPv4 or IPv6 address","required":true,"example":"8.8.8.8"}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"from","in":"query","schemaId":"schema_174","description":"UNIX epoch (UTC seconds) representing the start of the time range.","example":1736790000},{"name":"to","in":"query","schemaId":"schema_174","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"UNIX epoch (UTC seconds) representing the end of the time range. If supplied, "},"children":[]},{"$$mdtype":"Node","type":"code","inline":true,"attributes":{"content":"from"},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":" must also be set."},"children":[]}]}]}],"example":1736790285}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}/ip/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"example":"example.com","schemaId":"schema_175"},{"name":"source","in":"path","required":true,"example":"mailgun","schemaId":"schema_175"},{"name":"host","in":"path","required":true,"example":"mx.mailgun.com","schemaId":"schema_175"},{"name":"ip","in":"path","required":true,"example":"8.8.8.8","schemaId":"schema_175"}],"query":[{"name":"from","in":"query","required":false,"example":1736790000,"schemaId":"schema_174"},{"name":"to","in":"query","required":false,"example":1736790285,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}/ip/{ip}","href":"dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","openApiOperationId":"GET-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","summary":"Retrieve DMARC reporting data for an IP Address."},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"OK | Object representing DMARC info for an IP Address"},"children":[]}]}]}],"mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example"]}},"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example"]},{"code":"404","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Not found | IP related to host not found"},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"exampleIds":["paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example"]}}},{"code":"404"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-ip-ip-"}],"panels":[]}]},"httpPath":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}/ip/{ip}"}],"content":{"contentType":"group","meta":{"name":"DMARC Reports"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"DMARC Reports","showPageActions":true},{"nodeType":"markdoc","content":"DMARC reporting provides valuable insights into your infrastructure, helping you identify potential issues like senders, misconfigured email servers, or phishing attempts."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/dmarc/records/{domain}","summary":"Retrieves the DMARC DNS records to be used for configuration","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-records-domain-","deprecated":false},{"title":"/v1/dmarc/setup","summary":"Checks if DMARC has been setup for user","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-setup-","deprecated":false},{"title":"/v1/dmarc/referral","summary":"Gets referral link to redsift","prefix":{"name":"post","color":"post"},"badges":[],"link":"/dmarc-reports/post-v1-dmarc-referral-","deprecated":false},{"title":"/v1/dmarc/domains","summary":"Retrieves the list of domains that have DMARC monitoring.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-domains-","deprecated":false},{"title":"/v1/dmarc/domains/{domain}","summary":"Retrieve DMARC reporting data for a domain.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-domains-domain-","deprecated":false},{"title":"/v1/dmarc/domains/{domain}/s/{source}","summary":"Retrieve DMARC reporting data from a specific source.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-","deprecated":false},{"title":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}","summary":"Retrieve DMARC reporting data for a hostname.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-","deprecated":false},{"title":"/v1/dmarc/domains/{domain}/s/{source}/h/{host}/ip/{ip}","summary":"Retrieve DMARC reporting data for an IP Address.","prefix":{"name":"get","color":"get"},"badges":[],"link":"/dmarc-reports/get-v1-dmarc-domains-domain-s-source-h-host-ip-ip-","deprecated":false}]}]}]}]}},{"type":"group","label":"Inbox Placement","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement","items":[{"label":"List Seed Lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists","metadata":{"seo":{"title":"List Seed Lists","description":"List Seed Lists"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-seedlists","name":"List Seed Lists","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Seed Lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"name","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"pointer":"/paths/~1v4~1inbox~1seedlists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/seedlists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"name","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/seedlists","href":"inbox-placement/get-v4-inbox-seedlists","openApiOperationId":"GET-v4-inbox-seedlists","summary":"List Seed Lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1seedlists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-seedlists"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists"},{"label":"Generate a New Seed List","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-seedlists","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-seedlists","metadata":{"seo":{"title":"Generate a New Seed List","description":"Generate a New Seed List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-inbox-seedlists","name":"Generate a New Seed List","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists/post","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate a New Seed List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sending_domains","in":"query","schemaId":"schema_175","description":"Deprecated."},{"name":"name","in":"query","schemaId":"schema_175"},{"name":"provider_filter","in":"query","schemaId":"schema_175","description":"Array of provider domains. Omitting means all providers."},{"name":"remote_id","in":"query","schemaId":"schema_175"}],"pointer":"/paths/~1v4~1inbox~1seedlists/post/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/inbox/seedlists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"sending_domains","in":"query","schemaId":"schema_175"},{"name":"name","in":"query","schemaId":"schema_175"},{"name":"provider_filter","in":"query","schemaId":"schema_175"},{"name":"remote_id","in":"query","schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/seedlists","href":"inbox-placement/post-v4-inbox-seedlists","openApiOperationId":"POST-v4-inbox-seedlists","summary":"Generate a New Seed List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1seedlists/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/post-v4-inbox-seedlists"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists"},{"label":"List Available Attributes for Seed Lists","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a","metadata":{"seo":{"title":"List Available Attributes for Seed Lists","description":"List Available Attributes for Seed Lists"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-seedlists-a","name":"List Available Attributes for Seed Lists","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1a/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Available Attributes for Seed Lists","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/seedlists/a","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/seedlists/a","href":"inbox-placement/get-v4-inbox-seedlists-a","openApiOperationId":"GET-v4-inbox-seedlists-a","summary":"List Available Attributes for Seed Lists"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1seedlists~1a/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-seedlists-a"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/a"},{"label":"Get List of Values for Seed List Attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a--attribute-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists-a--attribute-","metadata":{"seo":{"title":"Get List of Values for Seed List Attribute","description":"Get List of Values for Seed List Attribute"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-seedlists-a--attribute-","name":"Get List of Values for Seed List Attribute","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get List of Values for Seed List Attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attribute","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/seedlists/a/{attribute}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"attribute","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/seedlists/a/{attribute}","href":"inbox-placement/get-v4-inbox-seedlists-a--attribute-","openApiOperationId":"GET-v4-inbox-seedlists-a--attribute-","summary":"Get List of Values for Seed List Attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-seedlists-a--attribute-"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/a/{attribute}"},{"label":"Get List of Available Seed List Filters","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--filters","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--filters","metadata":{"seo":{"title":"Get List of Available Seed List Filters","description":"Get List of Available Seed List Filters"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-seedlists--filters","name":"Get List of Available Seed List Filters","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1_filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get List of Available Seed List Filters","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/seedlists/_filters","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/seedlists/_filters","href":"inbox-placement/get-v4-inbox-seedlists--filters","openApiOperationId":"GET-v4-inbox-seedlists--filters","summary":"Get List of Available Seed List Filters"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1seedlists~1_filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-seedlists--filters"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/_filters"},{"label":"Get Seed List","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--address-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-seedlists--address-","metadata":{"seo":{"title":"Get Seed List","description":"Get Seed List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-seedlists--address-","name":"Get Seed List","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Seed List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/seedlists/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"address","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/seedlists/{address}","href":"inbox-placement/get-v4-inbox-seedlists--address-","openApiOperationId":"GET-v4-inbox-seedlists--address-","summary":"Get Seed List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-seedlists--address-"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/{address}"},{"label":"Update Seed List","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-seedlists--address-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-seedlists--address-","metadata":{"seo":{"title":"Update Seed List","description":"Update Seed List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-inbox-seedlists--address-","name":"Update Seed List","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Seed List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"name","in":"query","schemaId":"schema_175"},{"name":"provider_filter","in":"query","schemaId":"schema_175","description":"Array of provider domains. Omitting means no changes."},{"name":"regen","in":"query","schemaId":"schema_177","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Regenerate the mailing_list."},"children":[]}]}]}]},{"name":"sending_domains","in":"query","schemaId":"schema_175","description":"Deprecated."}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/inbox/seedlists/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"address","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"name","in":"query","schemaId":"schema_175"},{"name":"provider_filter","in":"query","schemaId":"schema_175"},{"name":"regen","in":"query","schemaId":"schema_177"},{"name":"sending_domains","in":"query","schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/seedlists/{address}","href":"inbox-placement/put-v4-inbox-seedlists--address-","openApiOperationId":"PUT-v4-inbox-seedlists--address-","summary":"Update Seed List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","exampleIds":["paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/put-v4-inbox-seedlists--address-"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/{address}"},{"label":"Delete a Seed List","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-seedlists--address-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-seedlists--address-","metadata":{"seo":{"title":"Delete a Seed List","description":"Delete a Seed List"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-inbox-seedlists--address-","name":"Delete a Seed List","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete a Seed List","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"address","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/inbox/seedlists/{address}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"address","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/seedlists/{address}","href":"inbox-placement/delete-v4-inbox-seedlists--address-","openApiOperationId":"DELETE-v4-inbox-seedlists--address-","summary":"Delete a Seed List"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1seedlists~1{address}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/delete-v4-inbox-seedlists--address-"}],"panels":[]}]},"httpPath":"/v4/inbox/seedlists/{address}"},{"label":"List Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results","metadata":{"seo":{"title":"List Results","description":"Get the details for all placement test results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-results","name":"List Results","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details for all placement test results."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sender","in":"query","schemaId":"schema_175"},{"name":"subject","in":"query","schemaId":"schema_175"},{"name":"provider","in":"query","schemaId":"schema_175"},{"name":"target_email","in":"query","schemaId":"schema_175"},{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"pointer":"/paths/~1v4~1inbox~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/results","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"sender","in":"query","schemaId":"schema_175"},{"name":"subject","in":"query","schemaId":"schema_175"},{"name":"provider","in":"query","schemaId":"schema_175"},{"name":"target_email","in":"query","schemaId":"schema_175"},{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/results","href":"inbox-placement/get-v4-inbox-results","openApiOperationId":"GET-v4-inbox-results","summary":"List Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1results/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-results"}],"panels":[]}]},"httpPath":"/v4/inbox/results"},{"label":"List Available Attributes for Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a","metadata":{"seo":{"title":"List Available Attributes for Results","description":"The attributes that can have values listed (for autocomplete)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-results-a","name":"List Available Attributes for Results","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results~1a/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Available Attributes for Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The attributes that can have values listed (for autocomplete)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/results/a","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/results/a","href":"inbox-placement/get-v4-inbox-results-a","openApiOperationId":"GET-v4-inbox-results-a","summary":"List Available Attributes for Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1results~1a/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-results-a"}],"panels":[]}]},"httpPath":"/v4/inbox/results/a"},{"label":"Get List of Values for a Result Attribute","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a--attribute-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results-a--attribute-","metadata":{"seo":{"title":"Get List of Values for a Result Attribute","description":"For the given attribute list the known values (for autocomplete)."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-results-a--attribute-","name":"Get List of Values for a Result Attribute","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results~1a~1{attribute}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get List of Values for a Result Attribute","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"For the given attribute list the known values (for autocomplete)."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"attribute","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1results~1a~1{attribute}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"sender","in":"query","schemaId":"schema_175"},{"name":"subject","in":"query","schemaId":"schema_175"},{"name":"provider","in":"query","schemaId":"schema_175"},{"name":"target_email","in":"query","schemaId":"schema_175"},{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"pointer":"/paths/~1v4~1inbox~1results~1a~1{attribute}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/results/a/{attribute}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"attribute","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"sender","in":"query","schemaId":"schema_175"},{"name":"subject","in":"query","schemaId":"schema_175"},{"name":"provider","in":"query","schemaId":"schema_175"},{"name":"target_email","in":"query","schemaId":"schema_175"},{"name":"time_after","in":"query","schemaId":"schema_175"},{"name":"time_before","in":"query","schemaId":"schema_175"},{"name":"cursor","in":"query","schemaId":"schema_175"},{"name":"sort","in":"query","schemaId":"schema_175"},{"name":"offset","in":"query","schemaId":"schema_174"},{"name":"ascending","in":"query","schemaId":"schema_177"},{"name":"limit","in":"query","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/results/a/{attribute}","href":"inbox-placement/get-v4-inbox-results-a--attribute-","openApiOperationId":"GET-v4-inbox-results-a--attribute-","summary":"Get List of Values for a Result Attribute"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-results-a--attribute-"}],"panels":[]}]},"httpPath":"/v4/inbox/results/a/{attribute}"},{"label":"List available filters for Results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--filters","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--filters","metadata":{"seo":{"title":"List available filters for Results","description":"The filters that can be used when querying for results."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-results--filters","name":"List available filters for Results","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results~1_filters/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List available filters for Results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The filters that can be used when querying for results."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/results/_filters","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/results/_filters","href":"inbox-placement/get-v4-inbox-results--filters","openApiOperationId":"GET-v4-inbox-results--filters","summary":"List available filters for Results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1results~1_filters/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-results--filters"}],"panels":[]}]},"httpPath":"/v4/inbox/results/_filters"},{"label":"Get Result Details","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--result-id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-results--result-id-","metadata":{"seo":{"title":"Get Result Details","description":"Get the details for a single result."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-results--result-id-","name":"Get Result Details","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Result Details","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get the details for a single result."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"result_id","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"provider","in":"query","schemaId":"schema_175"}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/results/{result_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"result_id","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"provider","in":"query","schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/results/{result_id}","href":"inbox-placement/get-v4-inbox-results--result-id-","openApiOperationId":"GET-v4-inbox-results--result-id-","summary":"Get Result Details"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","exampleIds":["paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-results--result-id-"}],"panels":[]}]},"httpPath":"/v4/inbox/results/{result_id}"},{"label":"Delete Result","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-results--result-id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/delete-v4-inbox-results--result-id-","metadata":{"seo":{"title":"Delete Result","description":"Delete the result and all associated information."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v4-inbox-results--result-id-","name":"Delete Result","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete the result and all associated information."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"result_id","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/delete/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"provider","in":"query","schemaId":"schema_175"}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v4/inbox/results/{result_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"result_id","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"provider","in":"query","schemaId":"schema_175"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404","500"],"pointer":"/v4/inbox/results/{result_id}","href":"inbox-placement/delete-v4-inbox-results--result-id-","openApiOperationId":"DELETE-v4-inbox-results--result-id-","summary":"Delete Result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1results~1{result_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200"},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/delete-v4-inbox-results--result-id-"}],"panels":[]}]},"httpPath":"/v4/inbox/results/{result_id}"},{"label":"Get Result Sharing Status","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing--result-id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing--result-id-","metadata":{"seo":{"title":"Get Result Sharing Status","description":"The sharing status of a result."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-sharing--result-id-","name":"Get Result Sharing Status","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Result Sharing Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The sharing status of a result."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"result_id","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/sharing/{result_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"result_id","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/sharing/{result_id}","href":"inbox-placement/get-v4-inbox-sharing--result-id-","openApiOperationId":"GET-v4-inbox-sharing--result-id-","summary":"Get Result Sharing Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-sharing--result-id-"}],"panels":[]}]},"httpPath":"/v4/inbox/sharing/{result_id}"},{"label":"Update Result Sharing Status","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-sharing--result-id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/put-v4-inbox-sharing--result-id-","metadata":{"seo":{"title":"Update Result Sharing Status","description":"Change the sharing status of a result or create a new share URL"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v4-inbox-sharing--result-id-","name":"Update Result Sharing Status","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Result Sharing Status","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change the sharing status of a result or create a new share URL"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"result_id","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/put/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"enabled","in":"query","schemaId":"schema_177","required":true}],"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/put/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v4/inbox/sharing/{result_id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"result_id","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"enabled","in":"query","required":true,"schemaId":"schema_177"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/sharing/{result_id}","href":"inbox-placement/put-v4-inbox-sharing--result-id-","openApiOperationId":"PUT-v4-inbox-sharing--result-id-","summary":"Update Result Sharing Status"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1sharing~1{result_id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","exampleIds":["paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/put-v4-inbox-sharing--result-id-"}],"panels":[]}]},"httpPath":"/v4/inbox/sharing/{result_id}"},{"label":"Get Result by a Share ID","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing-public--shareid-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-sharing-public--shareid-","metadata":{"seo":{"title":"Get Result by a Share ID","description":"Get a result by the share ID."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-sharing-public--shareid-","name":"Get Result by a Share ID","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1sharing~1public~1{shareid}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Result by a Share ID","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get a result by the share ID."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"shareid","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/sharing/public/{shareid}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"shareid","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","404"],"pointer":"/v4/inbox/sharing/public/{shareid}","href":"inbox-placement/get-v4-inbox-sharing-public--shareid-","openApiOperationId":"GET-v4-inbox-sharing-public--shareid-","summary":"Get Result by a Share ID"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","exampleIds":["paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","exampleIds":["paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","exampleIds":["paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","exampleIds":["paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-sharing-public--shareid-"}],"panels":[]}]},"httpPath":"/v4/inbox/sharing/public/{shareid}"},{"label":"Run Inbox Placement Test","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-tests","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/post-v4-inbox-tests","metadata":{"seo":{"title":"Run Inbox Placement Test","description":"Create and run a new inbox placement test."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v4-inbox-tests","name":"Run Inbox Placement Test","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1tests/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Run Inbox Placement Test","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Create and run a new inbox placement test."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Either 'html', 'template_name' or 'account_template_name' field should be provided."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"'variables' are "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/user-manual/sending-messages/send-templates"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Template variables"},"children":[]}]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":","},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which could be used in html or template."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"You can use next recipient variables inside Template variables,"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"which will be filled for every seed automatically:"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"%recipient.first_name%, %recipient.last_name%."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","exampleIds":["paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","exampleIds":["paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v4~1inbox~1tests/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v4/inbox/tests","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","exampleIds":["paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["202","400","403","404"],"pointer":"/v4/inbox/tests","href":"inbox-placement/post-v4-inbox-tests","openApiOperationId":"POST-v4-inbox-tests","summary":"Run Inbox Placement Test"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","exampleIds":["paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","exampleIds":["paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"202","description":"A 202 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","exampleIds":["paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","exampleIds":["paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v4~1inbox~1tests/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"202","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","exampleIds":["paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","exampleIds":["paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/post-v4-inbox-tests"}],"panels":[]}]},"httpPath":"/v4/inbox/tests"},{"label":"List Email Providers","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-providers","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/inbox-placement/get-v4-inbox-providers","metadata":{"seo":{"title":"List Email Providers","description":"List all available email providers."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v4-inbox-providers","name":"List Email Providers","isWebhook":false,"pointer":"/paths/~1v4~1inbox~1providers/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Email Providers","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List all available email providers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v4/inbox/providers","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200"],"pointer":"/v4/inbox/providers","href":"inbox-placement/get-v4-inbox-providers","openApiOperationId":"GET-v4-inbox-providers","summary":"List Email Providers"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","exampleIds":["paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","exampleIds":["paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v4~1inbox~1providers/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","exampleIds":["paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","exampleIds":["paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/inbox-placement/get-v4-inbox-providers"}],"panels":[]}]},"httpPath":"/v4/inbox/providers"}],"content":{"contentType":"group","meta":{"name":"Inbox Placement"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Inbox Placement","showPageActions":true},{"nodeType":"markdoc","content":"Inbox Placement testing allows you to see the likely deliverability of your email campaigns."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v4/inbox/seedlists","summary":"List Seed Lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-seedlists","deprecated":false},{"title":"/v4/inbox/seedlists","summary":"Generate a New Seed List","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inbox-placement/post-v4-inbox-seedlists","deprecated":false},{"title":"/v4/inbox/seedlists/a","summary":"List Available Attributes for Seed Lists","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-seedlists-a","deprecated":false},{"title":"/v4/inbox/seedlists/a/{attribute}","summary":"Get List of Values for Seed List Attribute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-seedlists-a--attribute-","deprecated":false},{"title":"/v4/inbox/seedlists/_filters","summary":"Get List of Available Seed List Filters","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-seedlists--filters","deprecated":false},{"title":"/v4/inbox/seedlists/{address}","summary":"Get Seed List","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-seedlists--address-","deprecated":false},{"title":"/v4/inbox/seedlists/{address}","summary":"Update Seed List","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inbox-placement/put-v4-inbox-seedlists--address-","deprecated":false},{"title":"/v4/inbox/seedlists/{address}","summary":"Delete a Seed List","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inbox-placement/delete-v4-inbox-seedlists--address-","deprecated":false},{"title":"/v4/inbox/results","summary":"List Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-results","deprecated":false},{"title":"/v4/inbox/results/a","summary":"List Available Attributes for Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-results-a","deprecated":false},{"title":"/v4/inbox/results/a/{attribute}","summary":"Get List of Values for a Result Attribute","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-results-a--attribute-","deprecated":false},{"title":"/v4/inbox/results/_filters","summary":"List available filters for Results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-results--filters","deprecated":false},{"title":"/v4/inbox/results/{result_id}","summary":"Get Result Details","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-results--result-id-","deprecated":false},{"title":"/v4/inbox/results/{result_id}","summary":"Delete Result","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/inbox-placement/delete-v4-inbox-results--result-id-","deprecated":false},{"title":"/v4/inbox/sharing/{result_id}","summary":"Get Result Sharing Status","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-sharing--result-id-","deprecated":false},{"title":"/v4/inbox/sharing/{result_id}","summary":"Update Result Sharing Status","prefix":{"name":"put","color":"put"},"badges":[],"link":"/inbox-placement/put-v4-inbox-sharing--result-id-","deprecated":false},{"title":"/v4/inbox/sharing/public/{shareid}","summary":"Get Result by a Share ID","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-sharing-public--shareid-","deprecated":false},{"title":"/v4/inbox/tests","summary":"Run Inbox Placement Test","prefix":{"name":"post","color":"post"},"badges":[],"link":"/inbox-placement/post-v4-inbox-tests","deprecated":false},{"title":"/v4/inbox/providers","summary":"List Email Providers","prefix":{"name":"get","color":"get"},"badges":[],"link":"/inbox-placement/get-v4-inbox-providers","deprecated":false}]}]}]}]}},{"type":"group","label":"Spam Traps Monitoring","link":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring","items":[{"label":"List Spam Trap Hits","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring/get-v2-spamtraps","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring/get-v2-spamtraps","metadata":{"seo":{"title":"List Spam Trap Hits","description":"Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v2-spamtraps","name":"List Spam Trap Hits","isWebhook":false,"pointer":"/paths/~1v2~1spamtraps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Spam Trap Hits","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_178","description":"The start timestamp in RFC3339 format(YYYY-MM-DDThh:mm:ssZ) of the timeframe for which you wish to see data. Default is 7 days ago"},{"name":"end","in":"query","schemaId":"schema_178","description":"The end timestamp in RFC3339 format(YYYY-MM-DDThh:mm:ssZ) of the timeframe for which you wish to see data. Default is now"},{"name":"dimension","in":"query","schemaId":"schema_179","description":"Use this field to group results."},{"name":"sort","in":"query","schemaId":"schema_180","description":"Sort field and order, in form of 'field:order'"},{"name":"ip","in":"query","schemaId":"schema_181","description":"Use this field to filter results by ip(s)."},{"name":"domain","in":"query","schemaId":"schema_181","description":"Use this field to filter results by domain(s)."},{"name":"sender","in":"query","schemaId":"schema_181","description":"Use this field to filter results by sender email address."},{"name":"from","in":"query","schemaId":"schema_181","description":"Use this field to filter results by from address."},{"name":"limit","in":"query","schemaId":"schema_174","description":"Limits the number of items returned in a request","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v2~1spamtraps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/spamtraps","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","schemaId":"schema_178"},{"name":"end","in":"query","schemaId":"schema_178"},{"name":"dimension","in":"query","schemaId":"schema_179"},{"name":"sort","in":"query","schemaId":"schema_180"},{"name":"ip","in":"query","schemaId":"schema_181"},{"name":"domain","in":"query","schemaId":"schema_181"},{"name":"sender","in":"query","schemaId":"schema_181"},{"name":"from","in":"query","schemaId":"schema_181"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v2/spamtraps","href":"spam-traps-monitoring/get-v2-spamtraps","openApiOperationId":"GET-v2-spamtraps","summary":"List Spam Trap Hits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","exampleIds":["paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","exampleIds":["paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v2~1spamtraps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","exampleIds":["paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","exampleIds":["paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spam-traps-monitoring/get-v2-spamtraps"}],"panels":[]}]},"httpPath":"/v2/spamtraps"},{"label":"Get Spam Trap Hits","deprecated":true,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring/get-v1-spamtraps","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/spam-traps-monitoring/get-v1-spamtraps","metadata":{"seo":{"title":"Get Spam Trap Hits","description":"Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type. Deprecated: Use /v2/spamtraps endpoint."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-spamtraps","name":"Get Spam Trap Hits","deprecated":true,"isWebhook":false,"pointer":"/paths/~1v1~1spamtraps/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Spam Trap Hits","isWebhook":false,"deprecated":true,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to understand how much of your mail being sent to known spam traps. This endpoint returns daily spam trap hit counts for a provided timerange, categorized by trap type. Deprecated: Use /v2/spamtraps endpoint."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"start","in":"query","schemaId":"schema_175","description":"The start date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.","required":true},{"name":"end","in":"query","schemaId":"schema_175","description":"The end date in UTC (format YYYY-MM-DD) of the timeframe for which you wish to see data.","required":true},{"name":"sortby","in":"query","schemaId":"schema_175","description":"Acceptable values include date, totals, domain, subject, ip, and from. Defaults to date."},{"name":"groupby","in":"query","schemaId":"schema_175","description":"Use this field to group results. Acceptable values include domain, subject, ip, and from."},{"name":"subject","in":"query","schemaId":"schema_181","description":"Use this field to filter results by email subject(s)."},{"name":"domain","in":"query","schemaId":"schema_181","description":"Use this field to filter results by domain(s)."},{"name":"ip","in":"query","schemaId":"schema_181","description":"Use this field to filter results by ip(s)."},{"name":"from","in":"query","schemaId":"schema_181","description":"Use this field to filter results by from address."},{"name":"limit","in":"query","schemaId":"schema_174","description":"Limits the number of items returned in a request","required":true}],"pointer":"/paths/~1v1~1spamtraps/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/spamtraps","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"start","in":"query","required":true,"schemaId":"schema_175"},{"name":"end","in":"query","required":true,"schemaId":"schema_175"},{"name":"sortby","in":"query","schemaId":"schema_175"},{"name":"groupby","in":"query","schemaId":"schema_175"},{"name":"subject","in":"query","schemaId":"schema_181"},{"name":"domain","in":"query","schemaId":"schema_181"},{"name":"ip","in":"query","schemaId":"schema_181"},{"name":"from","in":"query","schemaId":"schema_181"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/spamtraps","href":"spam-traps-monitoring/get-v1-spamtraps","openApiOperationId":"GET-v1-spamtraps","summary":"Get Spam Trap Hits"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1spamtraps/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/spam-traps-monitoring/get-v1-spamtraps"}],"panels":[]}]},"httpPath":"/v1/spamtraps"}],"content":{"contentType":"group","meta":{"name":"Spam Traps Monitoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Spam Traps Monitoring","showPageActions":true},{"nodeType":"markdoc","content":"Our spam trap monitoring service surfaces how much of your email is being sent to known spam traps."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v2/spamtraps","summary":"List Spam Trap Hits","prefix":{"name":"get","color":"get"},"badges":[],"link":"/spam-traps-monitoring/get-v2-spamtraps","deprecated":false},{"title":"/v1/spamtraps","summary":"Get Spam Trap Hits","prefix":{"name":"get","color":"http-deprecated"},"badges":[],"link":"/spam-traps-monitoring/get-v1-spamtraps","deprecated":true}]}]}]}]}},{"type":"group","label":"Email Health Score","link":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score","items":[{"label":"Get Email Health score and rates for account and subaccounts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score/get-v1-maverick-score-total","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score/get-v1-maverick-score-total","metadata":{"seo":{"title":"Get Email Health score and rates for account and subaccounts","description":"Get Email Health score and rates for account and subaccounts"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-maverick-score-total","name":"Get Email Health score and rates for account and subaccounts","isWebhook":false,"pointer":"/paths/~1v1~1maverick-score~1total/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Email Health score and rates for account and subaccounts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_182","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1maverick-score~1total/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/maverick-score/total","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"include_subaccounts","in":"query","required":false,"schemaId":"schema_182"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403","422"],"pointer":"/v1/maverick-score/total","href":"email-health-score/get-v1-maverick-score-total","openApiOperationId":"GET-v1-maverick-score-total","summary":"Get Email Health score and rates for account and subaccounts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","exampleIds":["paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","exampleIds":["paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"422","description":"A 422 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1maverick-score~1total/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","exampleIds":["paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","exampleIds":["paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"422","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-health-score/get-v1-maverick-score-total"}],"panels":[]}]},"httpPath":"/v1/maverick-score/total"},{"label":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score/get-v1-maverick-score-grouped","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/email-health-score/get-v1-maverick-score-grouped","metadata":{"seo":{"title":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps","description":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-maverick-score-grouped","name":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps","isWebhook":false,"pointer":"/paths/~1v1~1maverick-score~1grouped/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_182","description":"Include subaccounts"},{"name":"skip","in":"query","schemaId":"schema_183","description":"Skips N items in a response."},{"name":"limit","in":"query","schemaId":"schema_184","description":"Limits the number of items returned in a response."},{"name":"group","in":"query","schemaId":"schema_185","description":"The key to group score by."},{"name":"term","in":"query","schemaId":"schema_181","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Filter (exact match) by account_id/domain/ip, e.g.: 'domain:example.com'"},"children":[]}]}]}]},{"name":"query","in":"query","schemaId":"schema_175","description":"Query filter (fuzzy), e.g.: 'domain:example.com'"},{"name":"sort","in":"query","schemaId":"schema_186","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Supports the following syntax 'sort=field:direction'. 'direction' must be one of asc, desc. Default 'direction' is asc."},"children":[]}]}]}]}],"pointer":"/paths/~1v1~1maverick-score~1grouped/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/maverick-score/grouped","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"include_subaccounts","in":"query","required":false,"schemaId":"schema_182"},{"name":"skip","in":"query","required":false,"schemaId":"schema_183"},{"name":"limit","in":"query","required":false,"schemaId":"schema_184"},{"name":"group","in":"query","required":false,"schemaId":"schema_185"},{"name":"term","in":"query","required":false,"schemaId":"schema_181"},{"name":"query","in":"query","required":false,"schemaId":"schema_175"},{"name":"sort","in":"query","required":false,"schemaId":"schema_186"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","403","422"],"pointer":"/v1/maverick-score/grouped","href":"email-health-score/get-v1-maverick-score-grouped","openApiOperationId":"GET-v1-maverick-score-grouped","summary":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","exampleIds":["paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","exampleIds":["paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"422","description":"A 422 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1maverick-score~1grouped/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","exampleIds":["paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","exampleIds":["paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"422","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/email-health-score/get-v1-maverick-score-grouped"}],"panels":[]}]},"httpPath":"/v1/maverick-score/grouped"}],"content":{"contentType":"group","meta":{"name":"Email Health Score"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Email Health Score","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/maverick-score/total","summary":"Get Email Health score and rates for account and subaccounts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-health-score/get-v1-maverick-score-total","deprecated":false},{"title":"/v1/maverick-score/grouped","summary":"List Email Health score and rates grouped by domains/ips/subaccounts/timestamps","prefix":{"name":"get","color":"get"},"badges":[],"link":"/email-health-score/get-v1-maverick-score-grouped","deprecated":false}]}]}]}]}},{"type":"group","label":"IP Blocklist Monitoring","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring","items":[{"label":"Lists monitored IP addresses","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses","metadata":{"seo":{"title":"Lists monitored IP addresses","description":"Lists monitored IP addresses"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-inboxready-ip-addresses","name":"Lists monitored IP addresses","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1ip_addresses/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Lists monitored IP addresses","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_187","description":"Limit"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/inboxready/ip_addresses","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","schemaId":"schema_187"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403"],"pointer":"/v1/inboxready/ip_addresses","href":"ip-blocklist-monitoring/get-v1-inboxready-ip-addresses","openApiOperationId":"GET-v1-inboxready-ip-addresses","summary":"Lists monitored IP addresses"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses"}],"panels":[]}]},"httpPath":"/v1/inboxready/ip_addresses"},{"label":"Register an IP address","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/post-v1-inboxready-ip-addresses","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/post-v1-inboxready-ip-addresses","metadata":{"seo":{"title":"Register an IP address","description":"Register an IP address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-inboxready-ip-addresses","name":"Register an IP address","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1ip_addresses/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Register an IP address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1inboxready~1ip_addresses/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/inboxready/ip_addresses","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["201","400","403","409"],"pointer":"/v1/inboxready/ip_addresses","href":"ip-blocklist-monitoring/post-v1-inboxready-ip-addresses","openApiOperationId":"POST-v1-inboxready-ip-addresses","summary":"Register an IP address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"201","description":"A 201 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"201","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-blocklist-monitoring/post-v1-inboxready-ip-addresses"}],"panels":[]}]},"httpPath":"/v1/inboxready/ip_addresses"},{"label":"Get the IP address","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses--ip-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses--ip-","metadata":{"seo":{"title":"Get the IP address","description":"Get the IP address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-inboxready-ip-addresses--ip-","name":"Get the IP address","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get the IP address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"schema_175","description":"IP address","required":true}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/inboxready/ip_addresses/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","403","404"],"pointer":"/v1/inboxready/ip_addresses/{ip}","href":"ip-blocklist-monitoring/get-v1-inboxready-ip-addresses--ip-","openApiOperationId":"GET-v1-inboxready-ip-addresses--ip-","summary":"Get the IP address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses--ip-"}],"panels":[]}]},"httpPath":"/v1/inboxready/ip_addresses/{ip}"},{"label":"Update the IP address","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/put-v1-inboxready-ip-addresses--ip-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/put-v1-inboxready-ip-addresses--ip-","metadata":{"seo":{"title":"Update the IP address","description":"Update the IP address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-inboxready-ip-addresses--ip-","name":"Update the IP address","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update the IP address","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"schema_175","description":"IP address","required":true}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq"}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq","pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/inboxready/ip_addresses/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq"}},"responseCodes":["200","400","403","404"],"pointer":"/v1/inboxready/ip_addresses/{ip}","href":"ip-blocklist-monitoring/put-v1-inboxready-ip-addresses--ip-","openApiOperationId":"PUT-v1-inboxready-ip-addresses--ip-","summary":"Update the IP address"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-blocklist-monitoring/put-v1-inboxready-ip-addresses--ip-"}],"panels":[]}]},"httpPath":"/v1/inboxready/ip_addresses/{ip}"},{"label":"Removes IP from monitoring","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/delete-v1-inboxready-ip-addresses--ip-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/ip-blocklist-monitoring/delete-v1-inboxready-ip-addresses--ip-","metadata":{"seo":{"title":"Removes IP from monitoring","description":"Removes IP from monitoring"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-inboxready-ip-addresses--ip-","name":"Removes IP from monitoring","isWebhook":false,"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Removes IP from monitoring","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"schema_175","description":"IP address","required":true}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/inboxready/ip_addresses/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","400","403","404"],"pointer":"/v1/inboxready/ip_addresses/{ip}","href":"ip-blocklist-monitoring/delete-v1-inboxready-ip-addresses--ip-","openApiOperationId":"DELETE-v1-inboxready-ip-addresses--ip-","summary":"Removes IP from monitoring"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/ip-blocklist-monitoring/delete-v1-inboxready-ip-addresses--ip-"}],"panels":[]}]},"httpPath":"/v1/inboxready/ip_addresses/{ip}"}],"content":{"contentType":"group","meta":{"name":"IP Blocklist Monitoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"IP Blocklist Monitoring","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/inboxready/ip_addresses","summary":"Lists monitored IP addresses","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses","deprecated":false},{"title":"/v1/inboxready/ip_addresses","summary":"Register an IP address","prefix":{"name":"post","color":"post"},"badges":[],"link":"/ip-blocklist-monitoring/post-v1-inboxready-ip-addresses","deprecated":false},{"title":"/v1/inboxready/ip_addresses/{ip}","summary":"Get the IP address","prefix":{"name":"get","color":"get"},"badges":[],"link":"/ip-blocklist-monitoring/get-v1-inboxready-ip-addresses--ip-","deprecated":false},{"title":"/v1/inboxready/ip_addresses/{ip}","summary":"Update the IP address","prefix":{"name":"put","color":"put"},"badges":[],"link":"/ip-blocklist-monitoring/put-v1-inboxready-ip-addresses--ip-","deprecated":false},{"title":"/v1/inboxready/ip_addresses/{ip}","summary":"Removes IP from monitoring","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/ip-blocklist-monitoring/delete-v1-inboxready-ip-addresses--ip-","deprecated":false}]}]}]}]}},{"type":"group","label":"Domain Blocklist Monitoring","link":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring","items":[{"label":"Get Monitored Domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains","metadata":{"seo":{"title":"Get Monitored Domains","description":"Gets all domains that are being monitored for blocklisting"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-monitoring-domains","name":"Get Monitored Domains","isWebhook":false,"pointer":"/paths/~1v1~1monitoring~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Monitored Domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Gets all domains that are being monitored for blocklisting"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1monitoring~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/monitoring/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/monitoring/domains","href":"domain-blocklist-monitoring/get-v1-monitoring-domains","openApiOperationId":"GET-v1-monitoring-domains","summary":"Get Monitored Domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1monitoring~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-blocklist-monitoring/get-v1-monitoring-domains"}],"panels":[]}]},"httpPath":"/v1/monitoring/domains"},{"label":"Get All Events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains-events","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains-events","metadata":{"seo":{"title":"Get All Events","description":"Get all events for all domains monitored"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-monitoring-domains-events","name":"Get All Events","isWebhook":false,"pointer":"/paths/~1v1~1monitoring~1domains~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get All Events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get all events for all domains monitored"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1monitoring~1domains~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/monitoring/domains/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/monitoring/domains/events","href":"domain-blocklist-monitoring/get-v1-monitoring-domains-events","openApiOperationId":"GET-v1-monitoring-domains-events","summary":"Get All Events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1monitoring~1domains~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-blocklist-monitoring/get-v1-monitoring-domains-events"}],"panels":[]}]},"httpPath":"/v1/monitoring/domains/events"},{"label":"Get Lists Domain is Listed in","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--blocklists","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--blocklists","metadata":{"seo":{"title":"Get Lists Domain is Listed in","description":"Get blocklists that the domain is listed in"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-monitoring-domains--domain--blocklists","name":"Get Lists Domain is Listed in","isWebhook":false,"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Lists Domain is Listed in","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get blocklists that the domain is listed in"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/monitoring/domains/{domain}/blocklists","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/monitoring/domains/{domain}/blocklists","href":"domain-blocklist-monitoring/get-v1-monitoring-domains--domain--blocklists","openApiOperationId":"GET-v1-monitoring-domains--domain--blocklists","summary":"Get Lists Domain is Listed in"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--blocklists"}],"panels":[]}]},"httpPath":"/v1/monitoring/domains/{domain}/blocklists"},{"label":"Get Events for Domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--events","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--events","metadata":{"seo":{"title":"Get Events for Domain","description":"Get events for a specific domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-monitoring-domains--domain--events","name":"Get Events for Domain","isWebhook":false,"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Events for Domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Get events for a specific domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"The domain name","required":true}],"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1events/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/monitoring/domains/{domain}/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400"],"pointer":"/v1/monitoring/domains/{domain}/events","href":"domain-blocklist-monitoring/get-v1-monitoring-domains--domain--events","openApiOperationId":"GET-v1-monitoring-domains--domain--events","summary":"Get Events for Domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--events"}],"panels":[]}]},"httpPath":"/v1/monitoring/domains/{domain}/events"}],"content":{"contentType":"group","meta":{"name":"Domain Blocklist Monitoring"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Domain Blocklist Monitoring","showPageActions":true},{"nodeType":"markdoc","content":"Blocklist Monitoring enables you to keep an eye on your reputation. Monitor your domains against our curated list of blocklist providers to make sure you aren't being blocked."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/monitoring/domains","summary":"Get Monitored Domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-blocklist-monitoring/get-v1-monitoring-domains","deprecated":false},{"title":"/v1/monitoring/domains/events","summary":"Get All Events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-blocklist-monitoring/get-v1-monitoring-domains-events","deprecated":false},{"title":"/v1/monitoring/domains/{domain}/blocklists","summary":"Get Lists Domain is Listed in","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--blocklists","deprecated":false},{"title":"/v1/monitoring/domains/{domain}/events","summary":"Get Events for Domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/domain-blocklist-monitoring/get-v1-monitoring-domains--domain--events","deprecated":false}]}]}]}]}},{"type":"group","label":"Google Postmaster Tools","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools","items":[{"label":"Get GPT Domain","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-","metadata":{"seo":{"title":"Get GPT Domain","description":"Returns domain records for a single domain on the account. Each domain record is for a single domain on a single day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-gpt-domains--domain-","name":"Get GPT Domain","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT Domain","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns domain records for a single domain on the account. Each domain record is for a single domain on a single day."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true},{"name":"timeRangeStart","in":"query","schemaId":"schema_174","description":"Unix timestamp starting time filter.","required":true},{"name":"timeRangeEnd","in":"query","schemaId":"schema_174","description":"Unix timestamp ending time filter.","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/gpt/domains/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeStart","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeEnd","in":"query","required":true,"schemaId":"schema_174"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/gpt/domains/{domain}","href":"google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-","openApiOperationId":"GET-v1-reputationanalytics-gpt-domains--domain-","summary":"Get GPT Domain"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/gpt/domains/{domain}"},{"label":"Get GPT Domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains","metadata":{"seo":{"title":"Get GPT Domains","description":"Returns a list of all domain records for an account. Each domain record is for a single domain on a single day."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-gpt-domains","name":"Get GPT Domains","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT Domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all domain records for an account. Each domain record is for a single domain on a single day."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true},{"name":"timeRangeStart","in":"query","schemaId":"schema_174","description":"Unix timestamp starting time filter.","required":true},{"name":"timeRangeEnd","in":"query","schemaId":"schema_174","description":"Unix timestamp ending time filter.","required":true}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/gpt/domains","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeStart","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeEnd","in":"query","required":true,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/gpt/domains","href":"google-postmaster-tools/get-v1-reputationanalytics-gpt-domains","openApiOperationId":"GET-v1-reputationanalytics-gpt-domains","summary":"Get GPT Domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/gpt/domains"},{"label":"Get GPT Domains","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list","metadata":{"seo":{"title":"Get GPT Domains","description":"Returns a list of all domains for an account"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-gpt-domains-list","name":"Get GPT Domains","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains_list/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT Domains","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all domains for an account"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true},{"name":"timeRangeStart","in":"query","schemaId":"schema_174","description":"Unix timestamp starting time filter.","required":true},{"name":"timeRangeEnd","in":"query","schemaId":"schema_174","description":"Unix timestamp ending time filter.","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/gpt/domains_list","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeStart","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeEnd","in":"query","required":true,"schemaId":"schema_174"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/gpt/domains_list","href":"google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list","openApiOperationId":"GET-v1-reputationanalytics-gpt-domains-list","summary":"Get GPT Domains"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/gpt/domains_list"},{"label":"Get GPT FBL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl","metadata":{"seo":{"title":"Get GPT FBL","description":"Returns the FBL for the account or domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-gpt-domainsfbl","name":"Get GPT FBL","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT FBL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the FBL for the account or domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true},{"name":"timeRangeStart","in":"query","schemaId":"schema_174","description":"Unix timestamp starting time filter.","required":true},{"name":"timeRangeEnd","in":"query","schemaId":"schema_174","description":"Unix timestamp ending time filter.","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/gpt/domainsfbl","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeStart","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeEnd","in":"query","required":true,"schemaId":"schema_174"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/gpt/domainsfbl","href":"google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl","openApiOperationId":"GET-v1-reputationanalytics-gpt-domainsfbl","summary":"Get GPT FBL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/gpt/domainsfbl"},{"label":"Get GPT FBL","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl--domain-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl--domain-","metadata":{"seo":{"title":"Get GPT FBL","description":"Returns the FBL for the account or domain"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-gpt-domainsfbl--domain-","name":"Get GPT FBL","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT FBL","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the FBL for the account or domain"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true},{"name":"timeRangeStart","in":"query","schemaId":"schema_174","description":"Unix timestamp starting time filter.","required":true},{"name":"timeRangeEnd","in":"query","schemaId":"schema_174","description":"Unix timestamp ending time filter.","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/gpt/domainsfbl/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeStart","in":"query","required":true,"schemaId":"schema_174"},{"name":"timeRangeEnd","in":"query","required":true,"schemaId":"schema_174"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/gpt/domainsfbl/{domain}","href":"google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl--domain-","openApiOperationId":"GET-v1-reputationanalytics-gpt-domainsfbl--domain-","summary":"Get GPT FBL"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl--domain-"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/gpt/domainsfbl/{domain}"},{"label":"Get GPT v2 Compliances","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances","metadata":{"seo":{"title":"Get GPT v2 Compliances","description":"Returns a list of the most recent compliance records for all domains."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v2-reputationanalytics-gpt-compliances","name":"Get GPT v2 Compliances","isWebhook":false,"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT v2 Compliances","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of the most recent compliance records for all domains."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"limit","in":"query","schemaId":"schema_174","description":"The number of records to return.","required":true}],"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/reputationanalytics/gpt/compliances","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"limit","in":"query","required":true,"schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v2/reputationanalytics/gpt/compliances","href":"google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances","openApiOperationId":"GET-v2-reputationanalytics-gpt-compliances","summary":"Get GPT v2 Compliances"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances"}],"panels":[]}]},"httpPath":"/v2/reputationanalytics/gpt/compliances"},{"label":"Get GPT v2 Domain Compliance","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances--domain-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances--domain-","metadata":{"seo":{"title":"Get GPT v2 Domain Compliance","description":"Returns the most recent compliance record for a specific domain."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v2-reputationanalytics-gpt-compliances--domain-","name":"Get GPT v2 Domain Compliance","isWebhook":false,"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get GPT v2 Domain Compliance","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns the most recent compliance record for a specific domain."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"domain","in":"path","schemaId":"schema_175","description":"The domain name to retrieve compliance data for.","required":true}],"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v2/reputationanalytics/gpt/compliances/{domain}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"domain","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v2/reputationanalytics/gpt/compliances/{domain}","href":"google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances--domain-","openApiOperationId":"GET-v2-reputationanalytics-gpt-compliances--domain-","summary":"Get GPT v2 Domain Compliance"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","exampleIds":["paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances--domain-"}],"panels":[]}]},"httpPath":"/v2/reputationanalytics/gpt/compliances/{domain}"}],"content":{"contentType":"group","meta":{"name":"Google Postmaster Tools"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Google Postmaster Tools","showPageActions":true},{"nodeType":"markdoc","content":"This API provides access to Google Postmaster data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/reputationanalytics/gpt/domains/{domain}","summary":"Get GPT Domain","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains--domain-","deprecated":false},{"title":"/v1/reputationanalytics/gpt/domains","summary":"Get GPT Domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains","deprecated":false},{"title":"/v1/reputationanalytics/gpt/domains_list","summary":"Get GPT Domains","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domains-list","deprecated":false},{"title":"/v1/reputationanalytics/gpt/domainsfbl","summary":"Get GPT FBL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl","deprecated":false},{"title":"/v1/reputationanalytics/gpt/domainsfbl/{domain}","summary":"Get GPT FBL","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v1-reputationanalytics-gpt-domainsfbl--domain-","deprecated":false},{"title":"/v2/reputationanalytics/gpt/compliances","summary":"Get GPT v2 Compliances","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances","deprecated":false},{"title":"/v2/reputationanalytics/gpt/compliances/{domain}","summary":"Get GPT v2 Domain Compliance","prefix":{"name":"get","color":"get"},"badges":[],"link":"/google-postmaster-tools/get-v2-reputationanalytics-gpt-compliances--domain-","deprecated":false}]}]}]}]}},{"type":"group","label":"Microsoft SNDS","link":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds","items":[{"label":"Get SNDS Address Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds/get-v1-reputationanalytics-snds","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds/get-v1-reputationanalytics-snds","metadata":{"seo":{"title":"Get SNDS Address Info","description":"Returns a list of all address summary records for an account. Each record is for a single address's summary data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-snds","name":"Get SNDS Address Info","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1snds/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SNDS Address Info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all address summary records for an account. Each record is for a single address's summary data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"offset","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"sortBy","in":"query","schemaId":"schema_175","description":"Field name to sort by.","required":true},{"name":"orderBy","in":"query","schemaId":"schema_175","description":"'asc' or 'desc' sorting.","required":true},{"name":"search","in":"query","schemaId":"schema_175","description":"Value of the address to search","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1snds/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/snds","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"offset","in":"query","required":true,"schemaId":"schema_174"},{"name":"sortBy","in":"query","required":true,"schemaId":"schema_175"},{"name":"orderBy","in":"query","required":true,"schemaId":"schema_175"},{"name":"search","in":"query","required":true,"schemaId":"schema_175"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/snds","href":"microsoft-snds/get-v1-reputationanalytics-snds","openApiOperationId":"GET-v1-reputationanalytics-snds","summary":"Get SNDS Address Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1snds/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/microsoft-snds/get-v1-reputationanalytics-snds"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/snds"},{"label":"Get SNDS Address Info","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds/get-v1-reputationanalytics-snds--ip-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/microsoft-snds/get-v1-reputationanalytics-snds--ip-","metadata":{"seo":{"title":"Get SNDS Address Info","description":"Returns a list of all address summary records for an account and a single address"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-reputationanalytics-snds--ip-","name":"Get SNDS Address Info","isWebhook":false,"pointer":"/paths/~1v1~1reputationanalytics~1snds~1{ip}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get SNDS Address Info","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns a list of all address summary records for an account and a single address"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"ip","in":"path","schemaId":"schema_175","required":true}],"pointer":"/paths/~1v1~1reputationanalytics~1snds~1{ip}/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"skip","in":"query","schemaId":"schema_174","description":"The record number to begin pagination with.","required":true},{"name":"sortBy","in":"query","schemaId":"schema_175","description":"Field name to sort by.","required":true},{"name":"orderBy","in":"query","schemaId":"schema_175","description":"'asc' or 'desc' sorting.","required":true},{"name":"search","in":"query","schemaId":"schema_175","description":"Value of the address to search","required":true},{"name":"include_subaccounts","in":"query","schemaId":"schema_176","description":"Include subaccounts"}],"pointer":"/paths/~1v1~1reputationanalytics~1snds~1{ip}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/reputationanalytics/snds/{ip}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"ip","in":"path","required":true,"schemaId":"schema_175"}],"query":[{"name":"skip","in":"query","required":true,"schemaId":"schema_174"},{"name":"sortBy","in":"query","required":true,"schemaId":"schema_175"},{"name":"orderBy","in":"query","required":true,"schemaId":"schema_175"},{"name":"search","in":"query","required":true,"schemaId":"schema_175"},{"name":"include_subaccounts","in":"query","schemaId":"schema_176"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","400","404","500"],"pointer":"/v1/reputationanalytics/snds/{ip}","href":"microsoft-snds/get-v1-reputationanalytics-snds--ip-","openApiOperationId":"GET-v1-reputationanalytics-snds--ip-","summary":"Get SNDS Address Info"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}},"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"},{"code":"500","description":"A 500 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError"}}},{"code":"404","schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError"}}},{"code":"500","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/microsoft-snds/get-v1-reputationanalytics-snds--ip-"}],"panels":[]}]},"httpPath":"/v1/reputationanalytics/snds/{ip}"}],"content":{"contentType":"group","meta":{"name":"Microsoft SNDS"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Microsoft SNDS","showPageActions":true},{"nodeType":"markdoc","content":"This API provides access to Microsoft SNDS data."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/reputationanalytics/snds","summary":"Get SNDS Address Info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/microsoft-snds/get-v1-reputationanalytics-snds","deprecated":false},{"title":"/v1/reputationanalytics/snds/{ip}","summary":"Get SNDS Address Info","prefix":{"name":"get","color":"get"},"badges":[],"link":"/microsoft-snds/get-v1-reputationanalytics-snds--ip-","deprecated":false}]}]}]}]}},{"type":"group","label":"Alerts","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts","items":[{"label":"List events","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-events","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-events","metadata":{"seo":{"title":"List events","description":"The current list of events that you can chose to receive alerts for."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-events","name":"List events","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1events/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List events","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"The current list of events that you can chose to receive alerts for."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/events","href":"alerts/get-v1-alerts-events","openApiOperationId":"GET-v1-alerts-events","summary":"List events"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1events/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","exampleIds":["paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-events"}],"panels":[]}]},"httpPath":"/v1/alerts/events"},{"label":"Add Alert","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-settings-events","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-settings-events","metadata":{"seo":{"title":"Add Alert","description":"Use this endpoint to add new alert settings record. This service facilitates notifications (Webhook, Slack, or Email) for both Mailgun Optimize and Send Alert threshold breaches."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-settings-events","name":"Add Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Use this endpoint to add new alert settings record. This service facilitates notifications (Webhook, Slack, or Email) for both Mailgun Optimize and Send Alert threshold breaches."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":3,"id":"alerts/post-v1-alerts-settings-events/request/webhooks","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"This section covers details around consuming alerts via webhooks. If you are familiar with Mailgun Send webhooks (which provide status updates on individual email deliveries),"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"there is a lot of overlapping similarity, however, there are also a few minor nuances to account for."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"alerts/post-v1-alerts-settings-events/request/securing-webhooks","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/securing-webhooks"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Securing Webhooks"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HMAC is used to verify the integrity as well as the authenticity of received webhooks. To verify the origin of a webhook:"},"children":[]}]}]},{"$$mdtype":"Node","type":"list","attributes":{"ordered":true,"marker":"."},"children":[{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Encode the webhook’s entire POST request body with the HMAC algorithm (using your webhook signing key and SHA256 digest mode)"},"children":[]}]}]},{"$$mdtype":"Node","type":"item","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Compare the resulting hexdigest to the signature provided in the POST request’s X-Sign header."},"children":[]}]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"NOTE: If you’re consuming Mailgun Send webhooks, please note that your Mailgun Send webhook signing key differs"},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"from your Alerts webhook signing key."},"children":[]},{"$$mdtype":"Node","type":"softbreak","inline":true,"attributes":{},"children":[]},{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Your Alerts webhook signing keys, used for both Optimize and Send Alert products, are available within the Mailgun Alerts UI."},"children":[]}]}]},{"$$mdtype":"Node","type":"heading","attributes":{"level":4,"id":"alerts/post-v1-alerts-settings-events/request/webhook-url-validation","deepLinkHash":"/alerts/post-v1-alerts-settings-events#alerts/post-v1-alerts-settings-events/request/webhook-url-validation"},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Webhook URL Validation"},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"When adding or updating a webhook URL for alerts, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned from your endpoint, the request will be rejected and your alert setting will not be saved. We intentionally chose to send a GET request instead of a POST when validating URLs so that your webhook endpoint does not have to account for test requests."},"children":[]}]}]},{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Additionally, when a POST request is sent to your webhook URL, if a 2xx is not returned, we will attempt retries via an exponential backoff strategy for up to ~8 hours. If the max retry count is reached, the alert will be disabled and the related alert settings record’s disabled_at field will be populated."},"children":[]}]}]}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1settings~1events/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/settings/events","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","409","default"],"pointer":"/v1/alerts/settings/events","href":"alerts/post-v1-alerts-settings-events","openApiOperationId":"POST-v1-alerts-settings-events","summary":"Add Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"409","description":"A 409 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","exampleIds":["paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"409","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-settings-events"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events"},{"label":"Update Alert","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-events--id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-events--id-","metadata":{"seo":{"title":"Update Alert","description":"Use this endpoint to update an existing alert setting record."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-events--id-","name":"Update Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Use this endpoint to update an existing alert setting record.\n\nNOTE: When updating a webhook alert, we will ensure the endpoint is reachable by sending a GET request to the provided URL. If a 200 response is not returned, a 400 will be returned and the alert setting update will be rejected."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_175","description":"The settings ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/events/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","404","default"],"pointer":"/v1/alerts/settings/events/{id}","href":"alerts/put-v1-alerts-settings-events--id-","openApiOperationId":"PUT-v1-alerts-settings-events--id-","summary":"Update Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"]}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-events--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events/{id}"},{"label":"Remove Alert","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-settings-events--id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-settings-events--id-","metadata":{"seo":{"title":"Remove Alert","description":"Remove Alert"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-settings-events--id-","name":"Remove Alert","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove Alert","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_175","description":"The settings ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/settings/events/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings/events/{id}","href":"alerts/delete-v1-alerts-settings-events--id-","openApiOperationId":"DELETE-v1-alerts-settings-events--id-","summary":"Remove Alert"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-settings-events--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/events/{id}"},{"label":"List Alerts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-settings","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-settings","metadata":{"seo":{"title":"List Alerts","description":"This endpoint returns a list of all configured alert settings for your account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-settings","name":"List Alerts","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Alerts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"This endpoint returns a list of all configured alert settings for your account."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/settings","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings","href":"alerts/get-v1-alerts-settings","openApiOperationId":"GET-v1-alerts-settings","summary":"List Alerts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","exampleIds":["paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-settings"}],"panels":[]}]},"httpPath":"/v1/alerts/settings"},{"label":"Update Slack settings","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-slack","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-slack","metadata":{"seo":{"title":"Update Slack settings","description":"Update Slack settings"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-slack","name":"Update Slack settings","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1slack/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update Slack settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","pointer":"/paths/~1v1~1alerts~1settings~1slack/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/slack","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"responseCodes":["204","default"],"pointer":"/v1/alerts/settings/slack","href":"alerts/put-v1-alerts-settings-slack","openApiOperationId":"PUT-v1-alerts-settings-slack","summary":"Update Slack settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1slack/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-slack"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/slack"},{"label":"Delete Slack settings","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-settings-slack","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-settings-slack","metadata":{"seo":{"title":"Delete Slack settings","description":"Delete Slack settings and Slack event settings for the Mailgun account."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-settings-slack","name":"Delete Slack settings","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1slack/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete Slack settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delete Slack settings and Slack event settings for the Mailgun account.\n\nTo revoke the Slack access token, use DELETE /v1/alerts/slack/oauth.\n\nTo completely remove the Slack App from Slack Workspace, go into App Configuration in Slack."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/settings/slack","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","default"],"pointer":"/v1/alerts/settings/slack","href":"alerts/delete-v1-alerts-settings-slack","openApiOperationId":"DELETE-v1-alerts-settings-slack","summary":"Delete Slack settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1slack/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-settings-slack"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/slack"},{"label":"Reset Webhook Signing Key","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-webhooks-signing-key","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/put-v1-alerts-settings-webhooks-signing-key","metadata":{"seo":{"title":"Reset Webhook Signing Key","description":"Reset Webhook Signing Key"}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"PUT-v1-alerts-settings-webhooks-signing-key","name":"Reset Webhook Signing Key","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1settings~1webhooks~1signing_key/put","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Reset Webhook Signing Key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/alerts/settings/webhooks/signing_key","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","default"],"pointer":"/v1/alerts/settings/webhooks/signing_key","href":"alerts/put-v1-alerts-settings-webhooks-signing-key","openApiOperationId":"PUT-v1-alerts-settings-webhooks-signing-key","summary":"Reset Webhook Signing Key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1settings~1webhooks~1signing_key/put/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/put-v1-alerts-settings-webhooks-signing-key"}],"panels":[]}]},"httpPath":"/v1/alerts/settings/webhooks/signing_key"},{"label":"Test webhook","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-webhooks-test","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-webhooks-test","metadata":{"seo":{"title":"Test webhook","description":"Sends test webhook request to specified url with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-webhooks-test","name":"Test webhook","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test webhook","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test webhook request to specified url with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/webhooks/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400","default"],"pointer":"/v1/alerts/webhooks/test","href":"alerts/post-v1-alerts-webhooks-test","openApiOperationId":"POST-v1-alerts-webhooks-test","summary":"Test webhook"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","exampleIds":["paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1webhooks~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-webhooks-test"}],"panels":[]}]},"httpPath":"/v1/alerts/webhooks/test"},{"label":"Test message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-email-test","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-email-test","metadata":{"seo":{"title":"Test message","description":"Sends test message to emails with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-email-test","name":"Test message","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1email~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test message to emails with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1email~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/email/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/alerts/email/test","href":"alerts/post-v1-alerts-email-test","openApiOperationId":"POST-v1-alerts-email-test","summary":"Test message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","exampleIds":["paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1email~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-email-test"}],"panels":[]}]},"httpPath":"/v1/alerts/email/test"},{"label":"Test message","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-slack-test","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/post-v1-alerts-slack-test","metadata":{"seo":{"title":"Test message","description":"Sends test message to slack channels with dummy data."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"POST-v1-alerts-slack-test","name":"Test message","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1test/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Test message","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Sends test message to slack channels with dummy data."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"],"pointer":"/paths/~1v1~1alerts~1slack~1test/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/alerts/slack/test","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"responseCodes":["200","400"],"pointer":"/v1/alerts/slack/test","href":"alerts/post-v1-alerts-slack-test","openApiOperationId":"POST-v1-alerts-slack-test","summary":"Test message"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","exampleIds":["paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"]}},"examples":[{}]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"},{"code":"400","description":"A 400 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1slack~1test/post/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}},{"code":"400","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/post-v1-alerts-slack-test"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/test"},{"label":"Revoke Slack access token","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-slack-oauth","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/delete-v1-alerts-slack-oauth","metadata":{"seo":{"title":"Revoke Slack access token","description":"Revoke Slack access token, delete Slack settings and Slack event settings."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"DELETE-v1-alerts-slack-oauth","name":"Revoke Slack access token","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1oauth/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke Slack access token","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke Slack access token, delete Slack settings and Slack event settings.\n\nNOTE: All Mailgun accounts connected to the same Slack workspace share the same token.\n\nTo completely remove the Slack App from Slack Workspace, go into App Configuration in Slack."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/alerts/slack/oauth","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["204","default"],"pointer":"/v1/alerts/slack/oauth","href":"alerts/delete-v1-alerts-slack-oauth","openApiOperationId":"DELETE-v1-alerts-slack-oauth","summary":"Revoke Slack access token"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"204","description":"A 204 response"},{"code":"default","description":"A default response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}],"pointer":"/paths/~1v1~1alerts~1slack~1oauth/delete/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"204"},{"code":"default","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/delete-v1-alerts-slack-oauth"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/oauth"},{"label":"Get Slack channel","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-slack-channels--id-","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-slack-channels--id-","metadata":{"seo":{"title":"Get Slack channel","description":"Returns Slack channel."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-slack-channels--id-","name":"Get Slack channel","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get Slack channel","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Returns Slack channel."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_175","description":"The Slack channel ID.","required":true}],"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/slack/channels/{id}","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_175"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/alerts/slack/channels/{id}","href":"alerts/get-v1-alerts-slack-channels--id-","openApiOperationId":"GET-v1-alerts-slack-channels--id-","summary":"Get Slack channel"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-slack-channels--id-"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/channels/{id}"},{"label":"List Slack channels","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-slack-channels","routeSlug":"/docs/inboxready/api-reference/optimize/inboxready/alerts/get-v1-alerts-slack-channels","metadata":{"seo":{"title":"List Slack channels","description":"List Slack channels for the connected Slack workspace."}},"content":{"contentType":"item","itemVariant":"httpItem","meta":{"sourceId":"GET-v1-alerts-slack-channels","name":"List Slack channels","isWebhook":false,"pointer":"/paths/~1v1~1alerts~1slack~1channels/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List Slack channels","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List Slack channels for the connected Slack workspace."},{"nodeType":"security","requirements":[{"schemes":[{"name":"basicAuth","scopes":[],"type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"page","in":"query","schemaId":"schema_175","description":"Encoded paging information, provided via 'next', 'first' links"},{"name":"limit","in":"query","schemaId":"schema_174","description":"Limits the number of items returned in a request"}],"pointer":"/paths/~1v1~1alerts~1slack~1channels/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/alerts/slack/channels","servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"parameters":{"path":[],"query":[{"name":"page","in":"query","schemaId":"schema_175"},{"name":"limit","in":"query","schemaId":"schema_174"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"basicAuth","type":"http","scheme":"basic"}],"scopes":[]}],"responseCodes":["200","401","403","404"],"pointer":"/v1/alerts/slack/channels","href":"alerts/get-v1-alerts-slack-channels","openApiOperationId":"GET-v1-alerts-slack-channels","summary":"List Slack channels"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"A 200 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]},{"code":"401","description":"A 401 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]},{"code":"403","description":"A 403 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]},{"code":"404","description":"A 404 response","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}},"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}],"pointer":"/paths/~1v1~1alerts~1slack~1channels/get/responses"}],"panels":[{"children":[{"kind":"response","headerTitle":"Response","responseCodes":[{"code":"200","schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"]}}},{"code":"401","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"]}}},{"code":"403","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"]}}},{"code":"404","schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"],"mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","exampleIds":["paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"]}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/alerts/get-v1-alerts-slack-channels"}],"panels":[]}]},"httpPath":"/v1/alerts/slack/channels"}],"content":{"contentType":"group","meta":{"name":"Alerts"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Alerts","showPageActions":true}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/alerts/events","summary":"List events","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-events","deprecated":false},{"title":"/v1/alerts/settings/events","summary":"Add Alert","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-settings-events","deprecated":false},{"title":"/v1/alerts/settings/events/{id}","summary":"Update Alert","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-events--id-","deprecated":false},{"title":"/v1/alerts/settings/events/{id}","summary":"Remove Alert","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-settings-events--id-","deprecated":false},{"title":"/v1/alerts/settings","summary":"List Alerts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-settings","deprecated":false},{"title":"/v1/alerts/settings/slack","summary":"Update Slack settings","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-slack","deprecated":false},{"title":"/v1/alerts/settings/slack","summary":"Delete Slack settings","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-settings-slack","deprecated":false},{"title":"/v1/alerts/settings/webhooks/signing_key","summary":"Reset Webhook Signing Key","prefix":{"name":"put","color":"put"},"badges":[],"link":"/alerts/put-v1-alerts-settings-webhooks-signing-key","deprecated":false},{"title":"/v1/alerts/webhooks/test","summary":"Test webhook","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-webhooks-test","deprecated":false},{"title":"/v1/alerts/email/test","summary":"Test message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-email-test","deprecated":false},{"title":"/v1/alerts/slack/test","summary":"Test message","prefix":{"name":"post","color":"post"},"badges":[],"link":"/alerts/post-v1-alerts-slack-test","deprecated":false},{"title":"/v1/alerts/slack/oauth","summary":"Revoke Slack access token","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/alerts/delete-v1-alerts-slack-oauth","deprecated":false},{"title":"/v1/alerts/slack/channels/{id}","summary":"Get Slack channel","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-slack-channels--id-","deprecated":false},{"title":"/v1/alerts/slack/channels","summary":"List Slack channels","prefix":{"name":"get","color":"get"},"badges":[],"link":"/alerts/get-v1-alerts-slack-channels","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ListAlertsEventsResp","data":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string"}}},"required":["events"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/github.com-mailgun-alerts-channels-Channel":{"id":"components/schemas/github.com-mailgun-alerts-channels-Channel","kind":"json-schema","title":"github.com-mailgun-alerts-channels-Channel","data":{"type":"string","enum":["email","webhook","slack"],"description":"Alert channel type.","x-enumDescriptions":{"email":"email","webhook":"webhook","slack":"Slack"}}},"components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-DisabledChannel","data":{"type":"object","properties":{"disabled_at":{"type":"string","format":"date-time","description":"When the channel was disabled."},"reason":{"type":"string","description":"Why the channel was disabled."}},"required":["disabled_at","reason"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-ChannelSettings","data":{"type":"object","properties":{"url":{"type":"string","description":"For webhook channel."},"emails":{"type":"array","items":{"type":"string"},"description":"For email channel"},"channel_ids":{"type":"array","items":{"type":"string"},"description":"For slack channel"},"disabled_channel_ids":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-DisabledChannel"},"description":"List of disabled Slack channels."}}}},"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-EventSettings","data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The unique identifier for the alert settings record."},"event_type":{"type":"string","description":"The event type that is alerted on. Check GET /v1/alerts/events for possible values."},"channel":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-channels-Channel"}],"description":"The delivery channel for the alert."},"settings":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings"}],"description":"This object contains channel-specific settings."},"disabled_at":{"type":["string","null"],"format":"date-time","description":"When present, the timestamp indicating when a webhook endpoint was disabled."}},"required":["event_type","channel","settings"]}},"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-mutateEventSettingReq","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-mutateEventSettingReq","data":{"type":"object","properties":{"event_type":{"type":"string","description":"The type of event for which you would like to receive alerts."},"channel":{"type":"string","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-channels-Channel"}],"description":"The delivery method for the alert."},"settings":{"type":"object","allOf":[{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-ChannelSettings"}],"description":"The details pertaining to the specified channel. Please note that the contents of this object differ per channel type."}},"required":["event_type","channel","settings"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-Webhooks","data":{"type":"object","properties":{"signing_key":{"type":"string"}},"required":["signing_key"]}},"components/schemas/github.com-mailgun-alerts-internal-settings-Slack":{"id":"components/schemas/github.com-mailgun-alerts-internal-settings-Slack","kind":"json-schema","title":"github.com-mailgun-alerts-internal-settings-Slack","data":{"type":"object","properties":{"token":{"type":"string"},"team_id":{"type":["string","null"]},"team_name":{"type":["string","null"]},"scope":{"type":["string","null"]}},"required":["token","team_id","team_name","scope"]}},"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-SettingsResponse","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-SettingsResponse","data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-EventSettings"}},"webhooks":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-Webhooks"},"slack":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-settings-Slack"}},"required":["events","webhooks","slack"]}},"components/schemas/github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ResetWebhooksSigningKeyResp","data":{"type":"object","properties":{"signing_key":{"type":"string"}},"required":["signing_key"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestWebhookRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestWebhookRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"url":{"type":"string"}},"required":["event_type","url"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestEmailRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestEmailRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"emails":{"type":"array","items":{"type":"string"}}},"required":["event_type","emails"]}},"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-TestSlackRequest","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-TestSlackRequest","data":{"type":"object","properties":{"event_type":{"type":"string"},"channel_ids":{"type":"array","items":{"type":"string"},"description":"If omitted would be taken from the event settings"}},"required":["event_type"]}},"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-SlackChannel","data":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"is_archived":{"type":"boolean"}},"required":["id","name","is_archived"]}},"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse":{"id":"components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse","kind":"json-schema","title":"github.com-mailgun-scaffold-httpapi-paging-PagingResponse","data":{"type":"object","properties":{"previous":{"type":"string","description":"Previous page URL"},"first":{"type":"string","description":"First page URL"},"next":{"type":"string","description":"Next page URL"},"last":{"type":"string","description":"Last page URL"}},"required":["previous","first","next","last"]}},"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp":{"id":"components/schemas/github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","kind":"json-schema","title":"github.com-mailgun-alerts-internal-api-ListSlackChannelsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/github.com-mailgun-alerts-internal-api-SlackChannel"}},"paging":{"$ref":"#/components/schemas/github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items","paging"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Verified":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Verified","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-model-Verified","data":{"type":"object","properties":{"verified_at":{"type":"integer","format":"int64"},"status":{"type":"string"}},"required":["verified_at","status"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Domain":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Domain","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-model-Domain","data":{"type":"object","properties":{"acid":{"type":"string"},"created_at":{"type":"integer","format":"int64"},"name":{"type":"string"},"verified":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Verified"},"services":{"type":"object","additionalProperties":{"type":"boolean"}},"txt_record":{"type":"string"}},"required":["acid","created_at","name","verified","services","txt_record"]}},"components/schemas/Inbox_Ready_github.com-mailgun-scaffold-httpapi-paging-PagingResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-scaffold-httpapi-paging-PagingResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-scaffold-httpapi-paging-PagingResponse","data":{"type":"object","properties":{"previous":{"type":"string","description":"Previous page URL"},"first":{"type":"string","description":"First page URL"},"next":{"type":"string","description":"Next page URL"},"last":{"type":"string","description":"Last page URL"}},"required":["previous","first","next","last"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-DomainListResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Domain"}},"paging":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-scaffold-httpapi-paging-PagingResponse"}},"required":["items"]}},"components/schemas/Inbox_Ready_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-AddDomainResponse","data":{"type":"object","properties":{"message":{"type":"string"},"domain":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-inboxready-model-Domain"}},"required":["message","domain"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-DeleteDomainResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-InboxReadyVerifyDomainResponse":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-InboxReadyVerifyDomainResponse","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-InboxReadyVerifyDomainResponse","data":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-Blacklist":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-Blacklist","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-clients-medic-Blacklist","data":{"type":"object","properties":{"list":{"type":"string"},"delist_requested_at":{"type":"string","format":"date-time"},"first_seen":{"type":"string","format":"date-time"},"last_seen":{"type":"string","format":"date-time"},"comments":{"type":"array","items":{"type":"string"}},"name":{"type":"string"}},"required":["list","delist_requested_at","last_seen","comments"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress","data":{"type":"object","properties":{"ip":{"type":"string"},"ip_pool":{"type":"string"},"description":{"type":"string"},"state":{"type":"string"},"listed":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-Blacklist"}}},"required":["ip","ip_pool","description","state","listed"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-ListIPAddressesResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Ready_github.com-mailgun-inboxready-clients-medic-IPAddress"}}},"required":["items"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-CreateIPAddressReq","data":{"type":"object","properties":{"ip":{"type":"string"},"ip_pool":{"type":"string"},"description":{"type":"string"}},"required":["ip","ip_pool","description"]}},"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq":{"id":"components/schemas/Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq","kind":"json-schema","title":"Inbox_Ready_github.com-mailgun-inboxready-api-UpdateIPAddressReq","data":{"type":"object","properties":{"ip_pool":{"type":"string"},"description":{"type":"string"}},"required":["ip_pool","description"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-Blocklist":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-Blocklist","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-Blocklist","data":{"type":"object","properties":{"list":{"type":"string"},"name":{"type":"string"},"first_seen":{"type":"string","format":"date-time"},"last_seen":{"type":"string","format":"date-time"},"comments":{"type":"array","items":{"type":"string"}}},"required":["list","comments"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HealthRecord":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HealthRecord","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HealthRecord","data":{"type":"object","properties":{"domain":{"type":"string"},"account_id":{"type":"string","description":"Mailgun account ID."},"updated_at":{"type":"string","format":"date-time"},"state":{"type":"string"},"listed":{"type":"array","items":{"$ref":"#/components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-Blocklist"}}},"required":["domain","account_id","updated_at","state","listed"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-DomainsResponse","data":{"type":"object","properties":{"domains":{"type":"array","items":{"$ref":"#/components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HealthRecord"}}},"required":["domains"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HistoryRecord":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HistoryRecord","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HistoryRecord","data":{"type":"object","properties":{"timestamp":{"type":"string","format":"date-time"},"event":{"type":"string"},"domain":{"type":"string"},"account_id":{"type":"string"},"list":{"type":"string"},"name":{"type":"string"}},"required":["timestamp","event","domain","account_id","list"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-PagingResponse":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-PagingResponse","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-PagingResponse","data":{"type":"object","properties":{"previous":{"type":"string"},"first":{"type":"string"},"next":{"type":"string"},"last":{"type":"string"}},"required":["previous","first","next","last"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-EventsResponse","data":{"type":"object","properties":{"events":{"type":"array","items":{"$ref":"#/components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-HistoryRecord"}},"paging":{"$ref":"#/components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-PagingResponse"}},"required":["events","paging"]}},"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse":{"id":"components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","kind":"json-schema","title":"Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-api-BlocklistResponse","data":{"type":"object","properties":{"blocklists":{"type":"array","items":{"$ref":"#/components/schemas/Domain_Blocklist_Monitoring_github.com-mailgun-dbl_monitor-model-Blocklist"}}},"required":["blocklists"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-GroupedTotals":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-GroupedTotals","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-GroupedTotals","data":{"type":"object","properties":{"subject":{"type":"string"},"domain":{"type":"string"},"ip":{"type":"string"},"from":{"type":"string"},"pristine":{"type":"integer","format":"int32"},"recycled":{"type":"integer","format":"int32"},"typo":{"type":"integer","format":"int32"},"harvested":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["pristine","recycled","typo","harvested","total"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse","data":{"type":"object","properties":{"first":{"type":"string"},"previous":{"type":"string"},"next":{"type":"string"},"last":{"type":"string"}},"required":["first","previous","next","last"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-GroupedTotalsResponse":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-GroupedTotalsResponse","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-GroupedTotalsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-GroupedTotals"}},"paging":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse"}},"required":["items","paging"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-FiltersResponse":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-FiltersResponse","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-FiltersResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"type":"string"}},"paging":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse"}},"required":["items","paging"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-DatedTotals":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-DatedTotals","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-DatedTotals","data":{"type":"object","properties":{"date":{"type":"string"},"pristine":{"type":"integer","format":"int32"},"recycled":{"type":"integer","format":"int32"},"typo":{"type":"integer","format":"int32"},"harvested":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"}},"required":["date","pristine","recycled","typo","harvested","total"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-DatedTotalsResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-DatedTotals"}},"paging":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse"}},"required":["items","paging"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-CountsItem":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-CountsItem","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-CountsItem","data":{"type":"object","properties":{"account_id":{"type":["string","null"],"description":"Mailgun account ID."},"account_name":{"type":["string","null"],"description":"Mailgun account name."},"timestamp":{"type":["string","null"],"format":"date-time"},"domain":{"type":["string","null"],"description":"Domain name."},"ip":{"type":["string","null"],"description":"IP address."},"sender":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Sender address, e.g. john.smith@example.com"},"children":[]}]}]}]},"from":{"type":["string","null"],"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"From address, e.g. \"John Smith\" john.smith@example.com"},"children":[]}]}]}]},"tags":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Tags. See User Manual -> Tracking Messages -> Tagging for more details."},"children":[]}]}]}]},"ip_pool":{"type":["string","null"],"description":"IP pool ID."},"pristine":{"type":"integer","format":"int64","description":"Pristine counter."},"recycled":{"type":"integer","format":"int64","description":"Recycled counter."},"typo":{"type":"integer","format":"int64","description":"Typo counter."},"harvested":{"type":"integer","format":"int64","description":"Harvested counter."},"total":{"type":"integer","format":"int64","description":"Sum of pristine, recycled, typo, harvested counters."}},"required":["pristine","recycled","typo","harvested","total"]}},"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp":{"id":"components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","kind":"json-schema","title":"Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-ListCountsResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-model-CountsItem"}},"paging":{"$ref":"#/components/schemas/Spamtraps_Analytics_Service_github.com-mailgun-spamtraps-api-PagingResponse"},"total":{"type":"integer","format":"int64"}},"required":["items","paging","total"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-DeliveryStats":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-DeliveryStats","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-DeliveryStats","data":{"type":"object","properties":{"delivered":{"type":"integer","format":"int32"},"missing":{"type":"integer","format":"int32"},"pending":{"type":"integer","format":"int32"},"spam":{"type":"integer","format":"int32"},"inbox":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"provider":{"type":"string"},"categories":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"first_received_at":{"type":["string","null"],"format":"date-time"},"last_received_at":{"type":["string","null"],"format":"date-time"}},"required":["delivered","missing","pending","spam","inbox","total","provider","categories","first_received_at","last_received_at"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox","data":{"type":"object","properties":{"kid":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"last_result_at":{"type":"string","format":"date-time"},"target_email":{"type":"string"},"sending_domains":{"type":"array","items":{"type":"string"}},"has_results":{"type":"boolean"},"name":{"type":"string"},"seed_filter":{"type":"string"},"provider_filter":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"[] means all providers; null means that only seed_filter is used"},"children":[]}]}]}]},"mailing_list":{"type":"string"},"previous_mailing_list":{"type":"string","description":"List before last regen"},"tags":{"type":"object","additionalProperties":{"type":"string"}},"delivery_stats":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-DeliveryStats"}},"is_auto_generated":{"type":"boolean"},"version":{"type":"integer","format":"int32"},"regen_needed":{"type":"boolean","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Shows that mailing_list has to many unavailable seeds. Only for v2 Seed List."},"children":[]}]}]}]},"regen_at":{"type":"string","format":"date-time"},"max_seeds_per_provider":{"type":"integer","format":"int32","description":"Maximum number of seeds per provider. 0 means no limit."}},"required":["kid","created_at","updated_at","last_result_at","target_email","sending_domains","has_results","name","seed_filter","provider_filter","mailing_list","previous_mailing_list","tags","is_auto_generated","version","regen_needed","regen_at","max_seeds_per_provider"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-Response","data":{"type":"object","additionalProperties":{"type":"object"}}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-GetSeedListResp","data":{"type":"object","properties":{"seedlist":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-KeyBox"}},"required":["seedlist"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ResultSharingInfo","data":{"type":"object","properties":{"result_id":{"type":"string"},"expires_at":{"type":"string","format":"date-time"},"enabled":{"type":"boolean"},"url_id":{"type":"string"},"url":{"type":"string"},"api_url":{"type":"string"}},"required":["result_id","expires_at","enabled","url_id","url","api_url"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-headers-MessageHeader":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-headers-MessageHeader","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-headers-MessageHeader","data":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string"}},"required":["key","value"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontReport":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontReport","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontReport","data":{"type":"object","properties":{"category":{"type":"string"}},"required":["category"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamEntry":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamEntry","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamEntry","data":{"type":"object","properties":{"bcl":{"type":"integer","format":"int32"},"scl":{"type":"integer","format":"int32"},"forefront_report":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontReport"}},"required":["bcl","scl","forefront_report"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-MessageExtension":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-MessageExtension","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-MessageExtension","data":{"type":"object","properties":{"category":{"type":"string"},"ms_spam":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamEntry"},{"type":"null"}]}},"required":["category"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ExpectedMessage":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ExpectedMessage","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ExpectedMessage","data":{"type":"object","properties":{"email":{"type":"string"},"provider":{"type":"string"},"state":{"type":"string"},"destination":{"type":"string","description":"Folder where the message was delivered."},"originating_ip":{"type":"string"},"tags":{"type":"array","items":{"type":"string"}},"dkim":{"type":"string"},"spf":{"type":"string"},"dmarc":{"type":"string"},"headers":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-headers-MessageHeader"}},"extensions":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-MessageExtension"},{"type":"null"}]},"received_at":{"type":["string","null"],"format":"date-time"},"delivered_at":{"type":["string","null"],"format":"date-time"}},"required":["email","provider","state","destination","originating_ip","tags","extensions","received_at","delivered_at"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Rule":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Rule","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Rule","data":{"type":"object","properties":{"name":{"type":"string"},"points":{"type":"number","format":"float"},"short_description":{"type":"string"},"long_description":{"type":"string"}},"required":["name","points","short_description","long_description"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Result":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Result","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Result","data":{"type":"object","properties":{"is_spam":{"type":"boolean"},"score":{"type":"number","format":"float"},"required":{"type":"number","format":"float"},"rules":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Rule"}}},"required":["is_spam","score","required","rules"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-LevelStats":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-LevelStats","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-LevelStats","data":{"type":"object","properties":{"min":{"type":"integer","format":"int32"},"max":{"type":"integer","format":"int32"},"mean":{"type":"number","format":"float"}},"required":["min","max","mean"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontStats":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontStats","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontStats","data":{"type":"object","properties":{"category_counts":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}}},"required":["category_counts"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamSummary":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamSummary","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamSummary","data":{"type":"object","properties":{"bcl":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-LevelStats"},"scl":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-LevelStats"},"count":{"type":"integer","format":"int32"},"forefront":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-ForefrontStats"}},"required":["bcl","scl","count","forefront"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-AnalysisItem":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-AnalysisItem","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-AnalysisItem","data":{"type":"object","properties":{"status":{"type":["string","null"],"description":"analyzing, completed or failed"},"overview":{"type":"string"},"details":{"type":"array","items":{"type":"string"}},"version":{"type":"integer","format":"int32"},"updated_at":{"type":["string","null"],"format":"date-time"}},"required":["status","overview","details","version","updated_at"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-Analysis":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-Analysis","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-Analysis","data":{"type":"object","properties":{"content":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-AnalysisItem"},{"type":"null"}]},"deliverability":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-AnalysisItem"},{"type":"null"}]}},"required":["content","deliverability"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-TestResult","data":{"type":"object","properties":{"rid":{"type":"string"},"result_id":{"type":"string"},"keybox_email":{"type":"string"},"subject":{"type":"string"},"sender":{"type":"string"},"seedlist_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"status":{"type":"string"},"attributes":{"type":"object","additionalProperties":{"type":"string"}},"campaign_id":{"type":"string"},"sharing_enabled":{"type":"boolean"},"sharing_id":{"type":"string"},"sharing_expires_at":{"type":"string","format":"date-time"},"seed_results":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-ExpectedMessage"}},"spamassassin":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-net-spamassassin-Result"},"delivery_stats":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-DeliveryStats"}},"ms_spam":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-extensions-msspam-MicrosoftSpamSummary"},{"type":"null"}]},"body":{"type":"string","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"Only for GET /inbox/results/{result}"},"children":[]}]}]}]},"is_spoofing":{"type":["boolean","null"],"description":"Indicates whether spoofing was detected for this result."},"analysis":{"anyOf":[{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-model-Analysis"},{"type":"null"}]}},"required":["rid","result_id","keybox_email","subject","sender","seedlist_name","created_at","updated_at","status","attributes","campaign_id","sharing_enabled","sharing_id","sharing_expires_at","seed_results","spamassassin","delivery_stats","body","is_spoofing"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestRespLinks":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestRespLinks","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestRespLinks","data":{"type":"object","properties":{"results":{"type":"string"}},"required":["results"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestResp","data":{"type":"object","properties":{"result_id":{"type":"string"},"mailing_list":{"type":"string"},"links":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-CreateTestRespLinks"}},"required":["result_id","mailing_list","links"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-services-tests-PublicCreateTestReq","data":{"type":"object","properties":{"from":{"type":"string"},"subject":{"type":"string"},"html":{"type":"string"},"template_name":{"type":"string","description":"Domain-level template from Mailgun Send"},"account_template_name":{"type":"string","description":"Account-level template from Mailgun Send"},"variables":{"type":"object","additionalProperties":{"type":"object"}},"headers":{"type":"object","additionalProperties":{"type":"string"}},"seed_list":{"type":"string","description":"Use existing Seed List. If omitted creates new Seed List"},"provider_filter":{"type":"array","items":{"type":"string"},"description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"missing/null/[] means all providers"},"children":[]}]}]}]},"sending_ip_pool_id":{"type":"string","description":"If provided the email will be delivered with an IP that belongs in that pool"},"sending_ip":{"type":"string","description":"Used to specify an IP Address to send an email that is owned by your account"},"max_seeds_per_provider":{"type":"integer","format":"int32","description":"Maximum number of seeds per provider. 0 means no limit."}},"required":["from","subject"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-PublicProvider":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-PublicProvider","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-PublicProvider","data":{"type":"object","properties":{"domain":{"type":"string"},"display_name":{"type":"string"},"region":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}},"required":["domain","display_name","region","created_at","updated_at"]}},"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp":{"id":"components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","kind":"json-schema","title":"Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-ListPublicProvidersResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Inbox_Placement_Testing_github.com-mailgun-spy-internal-api-PublicProvider"}}},"required":["items"]}},"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates":{"id":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates","data":{"type":"object","properties":{"bounce_rate":{"type":"integer","format":"int32"},"complaint_rate":{"type":"integer","format":"int32"},"trap_rate":{"type":"integer","format":"int32"},"full_mailbox_rate":{"type":"integer","format":"int32"},"bad_failure_rate":{"type":"integer","format":"int32"}},"required":["bounce_rate","complaint_rate","trap_rate","full_mailbox_rate","bad_failure_rate"]}},"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Counters":{"id":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Counters","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Counters","data":{"type":"object","properties":{"delivered":{"type":"integer","format":"int64"}},"required":["delivered"]}},"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp":{"id":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-maverick-score-internal-entities-GetTotalResp","data":{"type":"object","properties":{"score":{"type":"integer","format":"int32"},"rates":{"$ref":"#/components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates"},"counters":{"$ref":"#/components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Counters"}},"required":["score","rates","counters"]}},"components/schemas/Maverick_Score_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/Maverick_Score_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore":{"id":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore","data":{"type":"object","properties":{"group_key":{"type":"string"},"account_id":{"type":"string"},"score":{"type":"integer","format":"int32"},"rates":{"$ref":"#/components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Rates"},"counters":{"$ref":"#/components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-entities-Counters"}},"required":["group_key","score","rates","counters"]}},"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp":{"id":"components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","kind":"json-schema","title":"Maverick_Score_github.com-mailgun-maverick-score-internal-api-ListScoreResp","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/Maverick_Score_github.com-mailgun-maverick-score-internal-api-GroupScore"}},"total":{"type":"integer","format":"int64"}},"required":["items","total"]}},"components/schemas/DMARC_Reports_ReferReq":{"id":"components/schemas/DMARC_Reports_ReferReq","kind":"json-schema","title":"A referral request","data":{"title":"A referral request","type":"object","properties":{"email":{"type":"string","description":"Email"}},"required":["email"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-DeliveryError":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-DeliveryError","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-DeliveryError","data":{"type":"object","properties":{"error_class":{"type":"string"},"error_type":{"type":"string"},"error_ratio":{"type":"number","format":"float"}},"required":["error_class","error_type","error_ratio"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-IPCount":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-IPCount","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-IPCount","data":{"type":"object","properties":{"reputation":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int64"}},"required":["reputation","total"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoop":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoop","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoop","data":{"type":"object","properties":{"id":{"type":"string"},"spam_ratio":{"type":"number","format":"float"}},"required":["id","spam_ratio"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-Domain":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-Domain","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-Domain","data":{"type":"object","properties":{"account_id":{"type":"string"},"name":{"type":"string"},"user_reported_spam_ratio":{"type":"number","format":"float"},"spf_success_ratio":{"type":"number","format":"float"},"dkim_success_ratio":{"type":"number","format":"float"},"dmarc_success_ratio":{"type":"number","format":"float"},"inbound_encryption_ratio":{"type":"number","format":"float"},"delivery_error_ratio":{"type":"number","format":"float"},"delivery_errors":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-DeliveryError"}},"reputation":{"type":"integer","format":"int32"},"date":{"type":["string","null"],"format":"date-time"},"ip_counts":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-IPCount"}},"feedback_loops":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoop"}}},"required":["name","user_reported_spam_ratio","spf_success_ratio","dkim_success_ratio","dmarc_success_ratio","inbound_encryption_ratio","delivery_error_ratio","delivery_errors","reputation","date","ip_counts","feedback_loops"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainResponse","data":{"type":"object","properties":{"domain":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-Domain"}},"total":{"type":"integer","format":"int64"}},"required":["domain","data","total"]}},"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError":{"id":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericAPIError","data":{"type":"object","properties":{"Reason":{"type":"string"}},"required":["Reason"]}},"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError":{"id":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-scaffold-httpapi-NotFoundError","data":{"type":"object","properties":{"Description":{"type":"string"}},"required":["Description"]}},"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericResponse":{"id":"components/schemas/reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericResponse","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-scaffold-httpapi-GenericResponse","data":{"type":"object","properties":{"message":{"type":"string","description":"Response message"}},"required":["message"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FullDomainListEntry":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FullDomainListEntry","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FullDomainListEntry","data":{"type":"object","properties":{"name":{"type":"string"},"date":{"type":"string"}},"required":["name","date"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-AllDomainsResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FullDomainListEntry"}},"total":{"type":"integer","format":"int64"}},"required":["data","total"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoopAggr":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoopAggr","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoopAggr","data":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string"},"ratio":{"type":"number","format":"float"},"date":{"type":["string","null"],"format":"date-time"}},"required":["name","id","ratio","date"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-DomainFBLResponse","data":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-domain-FeedbackLoopAggr"}},"total":{"type":"integer","format":"int64"}},"required":["data","total"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSData":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSData","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSData","data":{"type":"object","properties":{"block_text":{"type":"string"},"complaint_rate":{"type":"string"},"date":{"type":"string"},"filter_result":{"type":"string"},"is_blocked":{"type":"boolean"},"ip_address":{"type":"string"},"recipients":{"type":"integer","format":"int32"},"trap_hits":{"type":"integer","format":"int32"},"trap_message_period":{"type":"string"},"trap_percentage":{"type":"number","format":"float"}},"required":["block_text","complaint_rate","date","filter_result","is_blocked","ip_address","recipients","trap_hits","trap_message_period","trap_percentage"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSReturnStruct","data":{"type":"object","properties":{"summary":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-v1-SNDSData"}},"total":{"type":"integer","format":"int64"}},"required":["summary","total"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-Verdict":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-Verdict","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-Verdict","data":{"type":"object","properties":{"status":{"type":"string"},"reason":{"type":"string"}},"required":["status","reason"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-ComplianceData":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-ComplianceData","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-ComplianceData","data":{"type":"object","properties":{"honor_unsubscribe_verdict":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-Verdict"},"one_click_unsubscribe_verdict":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-Verdict"},"requirements":{"type":"object","additionalProperties":{"type":"string"}}},"required":["honor_unsubscribe_verdict","one_click_unsubscribe_verdict","requirements"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus","data":{"type":"object","properties":{"account_id":{"type":"string"},"etl_key":{"type":"string"},"domain_name":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"compliance_data":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-ComplianceData"},"subdomain_compliance_data":{"anyOf":[{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-ComplianceData"},{"type":"null"}]}},"required":["account_id","etl_key","domain_name","created_at","compliance_data","subdomain_compliance_data"]}},"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse":{"id":"components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","kind":"json-schema","title":"reputationanalytics_github.com-mailgun-reputationanalytics-api-gptv2-CompliancesResponse","data":{"type":"object","properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/reputationanalytics_github.com-mailgun-reputationanalytics-models-gpt-DomainComplianceStatus"}},"count":{"type":"integer","format":"int64"}},"required":["items","count"]}},"schema_174":{"kind":"json-schema","data":{"type":"integer"},"id":"schema_174"},"schema_175":{"kind":"json-schema","data":{"type":"string"},"id":"schema_175"},"schema_176":{"kind":"json-schema","data":{"type":"boolean","default":false},"id":"schema_176"},"schema_177":{"kind":"json-schema","data":{"type":"boolean"},"id":"schema_177"},"schema_178":{"kind":"json-schema","data":{"type":"string","format":"date-time"},"id":"schema_178"},"schema_179":{"kind":"json-schema","data":{"type":"string","enum":["timestamp","domain_name","ip","sender","from","tags","subaccount"],"x-enumDescriptions":{"timestamp":"Group by date","domain_name":"Group by domain","ip":"Group by IP address","sender":"Group by sender address","from":"Group by from","tags":"Group by tags","subaccount":"Group by subaccount"}},"id":"schema_179"},"schema_180":{"kind":"json-schema","data":{"type":"string","default":"same as dimension"},"id":"schema_180"},"schema_181":{"kind":"json-schema","data":{"type":"array","items":{"type":"string"}},"id":"schema_181"},"schema_182":{"kind":"json-schema","data":{"type":"boolean","default":true},"id":"schema_182"},"schema_183":{"kind":"json-schema","data":{"type":"integer","default":0},"id":"schema_183"},"schema_184":{"kind":"json-schema","data":{"type":"integer","maximum":100,"minimum":1,"default":10},"id":"schema_184"},"schema_185":{"kind":"json-schema","data":{"type":"string","enum":["domain","ip","subaccount","timestamp"],"default":"domain","x-enumDescriptions":{"domain":"Group by domain","ip":"Group by IP","subaccount":"Group by subaccount","timestamp":"Group by timestamp in 'YYYY-MM-DD' format"}},"id":"schema_185"},"schema_186":{"kind":"json-schema","data":{"type":"string","enum":["domain:asc","domain:desc","ip:asc","ip:desc","subaccount:asc","subaccount:desc","timestamp:asc","timestamp:desc","score:asc","score:desc","bounce_rate:asc","bounce_rate:desc","complaint_rate:asc","complaint_rate:desc","trap_rate:asc","trap_rate:desc","full_mailbox_rate:asc","full_mailbox_rate:desc","bad_failure_rate:asc","bad_failure_rate:desc","delivered:asc","delivered:desc"],"x-enumDescriptions":{"domain:asc":"domain:asc","domain:desc":"domain:desc","ip:asc":"ip:asc","ip:desc":"ip:desc","subaccount:asc":"subaccount:asc","subaccount:desc":"subaccount:desc","timestamp:asc":"timestamp:asc","timestamp:desc":"timestamp:desc","score:asc":"score:asc","score:desc":"score:desc","bounce_rate:asc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bounce_rate:asc"},"children":[]}]}]}],"bounce_rate:desc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bounce_rate:desc"},"children":[]}]}]}],"complaint_rate:asc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complaint_rate:asc"},"children":[]}]}]}],"complaint_rate:desc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"complaint_rate:desc"},"children":[]}]}]}],"trap_rate:asc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trap_rate:asc"},"children":[]}]}]}],"trap_rate:desc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"trap_rate:desc"},"children":[]}]}]}],"full_mailbox_rate:asc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full_mailbox_rate:asc"},"children":[]}]}]}],"full_mailbox_rate:desc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"full_mailbox_rate:desc"},"children":[]}]}]}],"bad_failure_rate:asc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bad_failure_rate:asc"},"children":[]}]}]}],"bad_failure_rate:desc":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"bad_failure_rate:desc"},"children":[]}]}]}],"delivered:asc":"delivered:asc","delivered:desc":"delivered:desc"}},"id":"schema_186"},"schema_187":{"kind":"json-schema","data":{"type":"integer","default":100},"id":"schema_187"}},"exampleStore":{"paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"acid":"mg_account:123","name":"domain.tld","verified":{"verified_at":123456789,"status":"pending"},"services":{"service_name":false},"txt_record":"IR-hashed-txt-record-key"}],"paging":{"previous":"https://....","first":"https://....","next":"https://....","last":"https://...."}},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example":{"value":{"message":"The domain has been added","domain":{"acid":"mg_account:123","name":"domain.tld","verified":{"verified_at":123456789,"status":"pending"},"services":{"service_name":false},"txt_record":"IR-hashed-txt-record-key"}},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"domain.tld has been removed from Mailgun Optimize"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"Domain pending verification"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains~1verify/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example":{"value":{"message":"No domain provided"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains~1verify/put/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example":{"value":{"message":"Domain not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1domains~1verify/put/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example":{"value":{"entry":"v=DMARC1; p=none; pct=100; fo=1; ri=3600; rua=mailto:abcdef12@inbox.ondmarc.com; ruf=mailto:abcdef12@inbox.ondmarc.com;","current":"v=DMARC1; p=none; pct=100; fo=1; ri=3600; rua=mailto:abcdef12@inbox.ondmarc.com; ruf=mailto:abcdef12@inbox.ondmarc.com;","configured":true},"id":"paths/~1v1~1dmarc~1records~1{domain}/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example":{"value":{"InstanceID":"d8798aa87905456b123c98745987f21379f9102389cc0981","LastAccessed":"2025-01-22T21:16:25.55Z","CreatedAt":"2025-01-22T21:16:25.55Z","UpdatedAt":"2025-01-22T21:16:25.55Z"},"id":"paths/~1v1~1dmarc~1setup/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example":{"value":{"referral_uri":"https://redsift.com/partners/mailgun?token=token"},"id":"paths/~1v1~1dmarc~1referral/post/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example":{"value":{"domains":[{"label":"Mailgun.com","uri":"/domains/mailgun.com","email_count":"79,","reputation":0.5,"compliance_rate":0.58,"dmarc_failures":"43,","spf_rate":0.9983,"dkim_rate":0.9977},{"label":"Mailjet.com","uri":"/domains/mailjet.com","email_count":"69,","reputation":1,"compliance_rate":0.65,"dmarc_failures":"30,","spf_rate":0.98,"dkim_rate":0.9243}],"pfqr_chart":[{"pass":111,"fail":11,"quarantined":123,"rejected":12334,"date":1736527388},{"pass":199,"fail":2,"quarantined":9,"rejected":0,"date":1736526388}]},"id":"paths/~1v1~1dmarc~1domains/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example":{"value":{"email_count":"79,","compliance_rate":0.58,"dmarc_policy":"p=none 100%","pfqr_chart":[{"pass":111,"fail":11,"quarantined":123,"rejected":12334,"date":1736527388},{"pass":199,"fail":2,"quarantined":9,"rejected":0,"date":1736526388}],"sources":[{"label":"mail.we.static.321","uri":"/domains/mailgun.com/s/mail.we.static.321","email_count":10,"reputation":0.5,"ip_count":1,"dmarc_failures":0,"spf_rate":0.98,"dkim_rate":0.9243,"ruf":"todo"},{"label":"mx.example.com","uri":"/domains/mailgun.com/s/mx.example.com","email_count":10,"reputation":0,"ip_count":3,"dmarc_failures":10,"spf_rate":0.9534,"dkim_rate":0.8743,"ruf":"todo"}]},"id":"paths/~1v1~1dmarc~1domains~1{domain}/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example":{"value":{"email_count":"79,","compliance_rate":0.58,"ip_count":2,"pfqr_chart":[{"pass":111,"fail":11,"quarantined":123,"rejected":12334,"date":1736527388},{"pass":199,"fail":2,"quarantined":9,"rejected":0,"date":1736526388}],"hostnames":[{"label":"123.4.54.123","uri":"/domains/mailgun.com/s/mx.example.com/h/123.4.54.123","email_count":10,"reputation":0.5,"ip_count":1,"dmarc_failures":0,"spf_rate":0.98,"dkim_rate":0.9243},{"label":"mx-1234.mx.example.com","uri":"/domains/mailgun.com/s/mx.example.com/h/mx-1234.mx.example.com","email_count":10,"reputation":0.5,"ip_count":3,"dmarc_failures":10,"spf_rate":0.9534,"dkim_rate":0.8743}],"auth_events":[{"protocol":"SPF","disposition":"none","reason":"Short reason","detail":"Detailed reason","result":"temperror","email_count":3,"dmarc_failures":0,"date":1736527388}]},"id":"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example":{"value":{"email_count":"79,","ip_count":2,"spf_fail_events":1,"dkim_fail_events":1,"auth_fail_events":1,"pfqr_chart":[{"pass":111,"fail":11,"quarantined":123,"rejected":12334,"date":1736527388},{"pass":199,"fail":2,"quarantined":9,"rejected":0,"date":1736526388}],"ip_addresses":[{"label":"123.4.54.123","uri":"/domains/mailgun.com/s/mx.example.com/h/123.4.54.123/ip/123.4.54.123","email_count":10,"reputation":0.5,"ip_count":1,"dmarc_failures":0,"spf_rate":0.98,"dkim_rate":0.9243,"ruf":"todo","country":"USA"},{"label":"8.8.8.8","uri":"/domains/mailgun.com/s/mx.example.com/h/123.4.54.123/ip/8.8.8.8","email_count":10,"reputation":0.5,"ip_count":3,"dmarc_failures":10,"spf_rate":0.9534,"dkim_rate":0.8743,"ruf":"todo","country":"CN"}],"auth_events":[{"protocol":"SPF","disposition":"none","reason":"Short reason","detail":"Detailed reason","result":"temperror","email_count":3,"dmarc_failures":0,"date":1736527388}]},"id":"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}/get/responses/200/content/application~1json/example"},"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example":{"value":{"email_count":"79,","ip_count":2,"spf_fail_events":1,"dkim_fail_events":1,"auth_fail_events":1,"ruf":"todo","pfqr_chart":[{"pass":111,"fail":11,"quarantined":123,"rejected":12334,"date":1736527388},{"pass":199,"fail":2,"quarantined":9,"rejected":0,"date":1736526388}],"auth_events":[{"protocol":"SPF","disposition":"none","reason":"Short reason","detail":"Detailed reason","result":"temperror","email_count":3,"dmarc_failures":0,"date":1736527388}]},"id":"paths/~1v1~1dmarc~1domains~1{domain}~1s~1{source}~1h~1{host}~1ip~1{ip}/get/responses/200/content/application~1json/example"},"paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"kid":"","id":"","accountid":"","producttype":"","createdat":"0001-01-01T00:00:00Z","updatedat":"0001-01-01T00:00:00Z","lastresult":"0001-01-01T00:00:00Z","targetemail":"","sendingdomains":[],"touched":false,"testprefix":"","seedfilter":"","providerfilter":[],"mailinglist":"","previousmailinglist":"","createdts":0,"tags":{},"stats":{},"seedquality":0,"isautogenerated":false,"version":0,"originseedsemails":[],"regenneeded":false,"regenat":"0001-01-01T00:00:00Z","maxseedsperprovider":0}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example":{"value":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","last_result_at":"0001-01-01T00:00:00Z","regen_at":"0001-01-01T00:00:00Z"},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists/post/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists~1a/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists~1_filters/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example":{"value":{"seedlist":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","last_result_at":"0001-01-01T00:00:00Z","target_email":"ibp-123@mailgun.net","name":"Campaign 1","mailing_list":"ibp-123@mailgun.net,seed@example.com","version":2,"regen_at":"0001-01-01T00:00:00Z"}},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists~1{address}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example":{"value":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","last_result_at":"0001-01-01T00:00:00Z","regen_at":"0001-01-01T00:00:00Z"},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1seedlists~1{address}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"basictestresult":{"rid":"","id":"","accountid":"","producttype":"","keyboxid":"","keyboxemail":"","subject":"","sender":"","prefix":"","createdat":"0001-01-01T00:00:00Z","updatedat":"0001-01-01T00:00:00Z","status":"","createdts":0,"headers":{},"campaignid":"","sharingenabled":false,"sharingid":"","sharingexpiry":"0001-01-01T00:00:00Z"},"box":{"kid":"","id":"","accountid":"","producttype":"","createdat":"0001-01-01T00:00:00Z","updatedat":"0001-01-01T00:00:00Z","lastresult":"0001-01-01T00:00:00Z","targetemail":"","sendingdomains":[],"touched":false,"testprefix":"","seedfilter":"","providerfilter":[],"mailinglist":"","previousmailinglist":"","createdts":0,"tags":{},"stats":{},"seedquality":0,"isautogenerated":false,"version":0,"originseedsemails":[],"regenneeded":false,"regenat":"0001-01-01T00:00:00Z","maxseedsperprovider":0},"messages":[],"spamassassin":{"isspam":false,"score":0,"required":0,"rules":[]},"stats":{},"microsoftspamstats":null,"storagekey":"","body":"","isspoofing":null,"analysis":null}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1results/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1results~1a/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1results~1a~1{attribute}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1results~1_filters/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example":{"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1results~1{result_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example":{"value":{"expires_at":"0001-01-01T00:00:00Z"},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1sharing~1{result_id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example":{"value":{"expires_at":"0001-01-01T00:00:00Z"},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1sharing~1{result_id}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example":{"value":{"BasicTestResult":{"created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z","sharing_expires_at":"0001-01-01T00:00:00Z"},"spamassassin":{}},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1sharing~1public~1{shareid}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example":{"value":{"from":"First Last <mail@example.com>","subject":"Buy our elephants","html":"<html><body>Hello {{first_name}} {{last_name}}. Visit our new shop at {{address}}. <b>Our elephants are the best.</b> </body></html>","template_name":"domain-template1","account_template_name":"account-template1","variables":{"address":"108, Robinson Ave, Richmond","first_name":"%recipient.first_name%","last_name":"%recipient.last_name%"},"seed_list":"ibp-123@mailgun.com","provider_filter":["gmail.com","hotmail.com"],"sending_ip_pool_id":"12345678901234567890abcd","sending_ip":"1.2.3.4"},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1tests/post/requestBody/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example":{"value":{"result_id":"uuid4","links":{"results":"https://api.mailgun.net/v4/inbox/results/uuid4"}},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1tests/post/responses/202/content/application~1json/examples/Example"},"paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"domain":"example.com","display_name":"Example","region":"Global","created_at":"0001-01-01T00:00:00Z","updated_at":"0001-01-01T00:00:00Z"}]},"key":"Example","summary":"Example","id":"paths/~1v4~1inbox~1providers/get/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"ip":"10.0.0.1","pristine":34,"recycled":258,"typo":178,"total":470},{"ip":"10.0.0.2","pristine":32,"recycled":75,"typo":150,"total":257}],"paging":{},"total":2},"key":"Example","summary":"Example","id":"paths/~1v2~1spamtraps/get/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v2~1spamtraps/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"date":"2022-01-01","pristine":34,"recycled":258,"typo":178,"total":470},{"date":"2022-01-02","pristine":32,"recycled":75,"typo":150,"total":257}],"paging":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1spamtraps/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1spamtraps/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example":{"value":{"score":37,"rates":{"bounce_rate":9,"complaint_rate":19,"trap_rate":3,"full_mailbox_rate":3,"bad_failure_rate":29},"counters":{"delivered":100500}},"key":"Example","summary":"Example","id":"paths/~1v1~1maverick-score~1total/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"group_key":"a.example.com","score":37,"rates":{"bounce_rate":9,"complaint_rate":19,"trap_rate":3,"full_mailbox_rate":3,"bad_failure_rate":29},"counters":{"delivered":100500}}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1maverick-score~1grouped/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"ip":"127.0.0.1","ip_pool":"swimming","description":"this is a description","state":"listed","listed":[{"list":"b.barracudacentral.org","delist_requested_at":"0001-01-01T00:00:00Z","first_seen":"2021-06-14T13:46:52Z","last_seen":"2022-06-14T13:46:52Z","comments":["http://www.barracudanetworks.com/reputation/?pr=1&ip=127.0.0.1"]}]}]},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example":{"value":{"UpdateIPAddressReq":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example":{"value":[{"ip":"127.0.0.1","ippool":"swimming","description":"this is a description","state":"listed","listed":[{"list":"b.barracudacentral.org","delistrequestedat":"0001-01-01T00:00:00Z","firstseen":"2021-06-14T13:46:52Z","lastseen":"2022-06-14T13:46:52Z","comments":["http://www.barracudanetworks.com/reputation/?pr=1&ip=127.0.0.1"],"name":""}]}],"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses/post/responses/201/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example":{"value":[{"ip":"127.0.0.1","ippool":"swimming","description":"this is a description","state":"listed","listed":[{"list":"b.barracudacentral.org","delistrequestedat":"0001-01-01T00:00:00Z","firstseen":"2021-06-14T13:46:52Z","lastseen":"2022-06-14T13:46:52Z","comments":["http://www.barracudanetworks.com/reputation/?pr=1&ip=127.0.0.1"],"name":""}]}],"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses~1{ip}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example":{"value":[{"ip":"127.0.0.1","ippool":"swimming","description":"this is a description","state":"listed","listed":[{"list":"b.barracudacentral.org","delistrequestedat":"0001-01-01T00:00:00Z","firstseen":"2021-06-14T13:46:52Z","lastseen":"2022-06-14T13:46:52Z","comments":["http://www.barracudanetworks.com/reputation/?pr=1&ip=127.0.0.1"],"name":""}]}],"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses~1{ip}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example":{"value":{"message":"description of the error"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example":{"value":{"message":"IP Blocklist monitoring not enabled"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example":{"value":{"message":"ip address not found"},"key":"Example","summary":"Example","id":"paths/~1v1~1inboxready~1ip_addresses~1{ip}/delete/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"domains":[{"domain":"yourdomain.com","updated_at":"2023-09-06T18:45:51Z","state":"heathly"},{"domain":"yourotherdomain.com","updated_at":"2023-09-06T18:45:51Z","state":"listed","listed":[{"list":"dbl.spamhaus.org","name":"Spamhaus DBL","first_seen":"2023-01-02T02:14:27Z","last_seen":"2023-09-06T18:45:51Z"}]}]},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example":{"value":{"events":[{"timestamp":"0001-01-01T00:00:00Z","event":"listed","domain":"yourotherdomain.com","account_id":"123","list":"Spamhaus DBL","name":"Spamhaus DBL"},{"timestamp":"0001-01-01T00:00:00Z","event":"delisted","domain":"yourdomain.com","account_id":"123","list":"Spamhaus DBL","name":"Spamhaus DBL"},{"timestamp":"0001-01-01T00:00:00Z","event":"listed","domain":"yourdomain.com","account_id":"123","list":"Spamhaus DBL","name":"Spamhaus DBL"}],"paging":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1events/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1events/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example":{"value":{"blocklists":[{"list":"Spamhaus DBL","name":"Spamhaus DBL","first_seen":"2023-01-02T02:14:27Z","last_seen":"2023-09-06T18:45:51Z","comments":[""]},{"list":"SURBL","name":"SURBL","first_seen":"2023-01-02T02:14:27Z","last_seen":"2023-09-06T18:45:51Z","comments":[""]}]},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1{domain}~1blocklists/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example":{"value":{"events":[{"timestamp":"0001-01-01T00:00:00Z","event":"delisted","domain":"yourdomain.com","list":"Spamhaus DBL","name":"Spamhaus DBL"},{"timestamp":"0001-01-01T00:00:00Z","event":"listed","domain":"yourdomain.com","list":"Spamhaus DBL","name":"Spamhaus DBL"}],"paging":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example":{"value":{"message":"reason for bad request"},"key":"Example","summary":"Example","id":"paths/~1v1~1monitoring~1domains~1{domain}~1events/get/responses/400/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example":{"value":{"domain":"test.com","data":[{"name":"test.com","date":"2026-03-14T00:00:00Z"}]},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains~1{domain}/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example":{"value":{"domain":"test.com","data":[{"name":"test.com","date":"2026-03-14T00:00:00Z"}]},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example":{"value":{"data":[{"name":"test.com","date":"2025-06-17"}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domains_list/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example":{"value":{"data":[{"name":"test.com","id":"identifier","ratio":0.001,"date":"2026-03-14T00:00:00Z"}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example":{"value":{"data":[{"name":"test.com","id":"identifier","ratio":0.001,"date":"2026-03-14T00:00:00Z"}]},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1gpt~1domainsfbl~1{domain}/get/responses/500/content/application~1json/examples/Example"},"paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"domain_name":"test.com","created_at":"2026-03-14T00:00:00Z","compliance_data":{"honor_unsubscribe_verdict":{"status":"COMPLIANT"},"one_click_unsubscribe_verdict":{"status":"NEEDS_WORK","reason":"a reason provided by google"}}}],"count":1},"key":"Example","summary":"Example","id":"paths/~1v2~1reputationanalytics~1gpt~1compliances/get/responses/200/content/application~1json/examples/Example"},"paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example":{"value":{"domain_name":"test.com","created_at":"2026-03-14T00:00:00Z","compliance_data":{"honor_unsubscribe_verdict":{"status":"COMPLIANT"},"one_click_unsubscribe_verdict":{"status":"NEEDS_WORK","reason":"a reason provided by google"}}},"key":"Example","summary":"Example","id":"paths/~1v2~1reputationanalytics~1gpt~1compliances~1{domain}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example":{"value":{"summary":[{"block_text":"Blocked","complaint_rate":"0.01","date":"Sat May 09 03:00:00 +0000 2026","filter_result":"Passed","ip_address":"0.0.0.0","recipients":100,"trap_hits":1,"trap_message_period":"24h","trap_percentage":0.01}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1snds/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1snds/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example":{"value":{"summary":[{"block_text":"Blocked","complaint_rate":"0.01","date":"Sat May 09 03:00:00 +0000 2026","filter_result":"Passed","ip_address":"0.0.0.0","recipients":100,"trap_hits":1,"trap_message_period":"24h","trap_percentage":0.01}],"total":1},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example":{"value":{"message":"Internal Server Error"},"key":"Example","summary":"Example","id":"paths/~1v1~1reputationanalytics~1snds~1{ip}/get/responses/500/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example":{"value":{"events":["ip_listed","ip_delisted"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1events/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"ip_listed","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example":{"value":{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_listed","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events/post/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"ip_delisted","channel":"email","settings":{"emails":["recipient-a@example.com","recipient-b@example.com"]}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/put/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example":{"value":{"message":"settings updated"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/put/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example":{"value":{"message":"settings deleted"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings~1events~1{id}/delete/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example":{"value":{"events":[{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_listed","channel":"webhook","settings":{"url":"https://example.com/delisted_hook"}},{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_delisted","channel":"webhook","settings":{"url":"https://yourwebhookurl.com"},"disabled_at":"2006-01-02T22:04:05Z"},{"id":"00000000-0000-0000-0000-000000000000","event_type":"ip_delisted","channel":"email","settings":{"emails":["recipient-1@example.com","recipient-2@example.com"]}}],"webhooks":{},"slack":{}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1settings/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","url":"https://some-webhook-url.com/webhook"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1webhooks~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","emails":["email1@example.com","email2@example.com"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1email~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example":{"value":{"event_type":"some-event","channel_ids":["C0123","C0456"]},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1test/post/requestBody/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example":{"value":{"id":"C012AB3CD","name":"general"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"token should have 'xoxb-' prefix"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"missing_scope: please reconnect the Slack App"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"no settings"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels~1{id}/get/responses/404/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example":{"value":{"items":[{"id":"C012AB3CD","name":"general"}],"paging":{"first":"https://api.mailgun.net/v1/alerts/slack/channels?page=foo","next":"https://api.mailgun.net/v1/alerts/slack/channels?page=bar"}},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/200/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example":{"value":{"message":"token should have 'xoxb-' prefix"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/401/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example":{"value":{"message":"missing_scope: please reconnect the Slack App"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/403/content/application~1json/examples/Example"},"paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example":{"value":{"message":"no settings"},"key":"Example","summary":"Example","id":"paths/~1v1~1alerts~1slack~1channels/get/responses/404/content/application~1json/examples/Example"}},"securitySchemeStore":{"basicAuth":{"id":"basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"Inbox_Ready_basicAuth":{"id":"Inbox_Ready_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"Domain_Blocklist_Monitoring_basicAuth":{"id":"Domain_Blocklist_Monitoring_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"Spamtraps_Analytics_Service_basicAuth":{"id":"Spamtraps_Analytics_Service_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"Inbox_Placement_Testing_basicAuth":{"id":"Inbox_Placement_Testing_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"Maverick_Score_basicAuth":{"id":"Maverick_Score_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"DMARC_Reports_basicAuth":{"id":"DMARC_Reports_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]},"reputationanalytics_basicAuth":{"id":"reputationanalytics_basicAuth","type":"http","scheme":"basic","description":[{"$$mdtype":"Node","type":"paragraph","attributes":{},"children":[{"$$mdtype":"Node","type":"inline","attributes":{},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"HTTP Basic auth using api:YOUR_API_KEY. See "},"children":[]},{"$$mdtype":"Node","type":"link","inline":true,"attributes":{"href":"https://documentation.mailgun.com/docs/mailgun/api-reference/authentication/"},"children":[{"$$mdtype":"Node","type":"text","inline":true,"attributes":{"content":"documentation"},"children":[]}]}]}]}]}},"servers":[{"url":"https://api.mailgun.net","description":"US Mailgun"},{"url":"https://api.eu.mailgun.net","description":"EU Mailgun"}]},"options":{"hideSidebar":true,"mockServer":{"url":"/_mock/docs/inboxready/api-reference/optimize/inboxready","position":"off","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/docs/inboxready/api-reference/optimize/inboxready.json?download"},{"url":"/_bundle/docs/inboxready/api-reference/optimize/inboxready.yaml?download"}],"excludeFromSearch":false,"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Alerts","description":"Our alerting solution is centered around two concepts: events and channels. The occurrence of an event can be configured to trigger an alert. A channel describes the delivery method for an alert. Every configured alert consists of an event type / channel pair. This level of granularity allows alerting to be configured to your exact preference."}},"baseSlug":"/docs/inboxready/api-reference/optimize/inboxready","routesMapping":{}}