Security (report)

Request

curl -X GET 'https://app.mailyte.com/api/v1/reports/security' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/reports/security', {
  method: 'GET',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.get(
    "https://app.mailyte.com/api/v1/reports/security",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->get('https://app.mailyte.com/api/v1/reports/security');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/reports/security")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringsecurity_report
  • generated_atstring

    When this response was computed, ISO 8601 UTC. Every report answers it, so "is this figure stale?" never depends on which report you asked.

  • periodobject

    Null while `availability.state` is `unavailable`, which is every response today: there is no window because nothing was measured over one.

    • start_atstring
    • end_atstring
    • granularitystringday

      The width of one `series` bucket. Always `day`: the `granularity` query parameter is accepted and ignored.

  • availabilityobject

    Whether there is a detection engine behind these figures. Check this BEFORE reading `totals` -- the counts are null, not zero, while it says `unavailable`.

    • statestringavailable | unavailable

      Today always `unavailable`. No spam, malware or phishing detection data source exists yet in mailyte-api or the mail server.

    • reasonstring

      Why the figures are unavailable. Null when they are not.

  • totalsobject

    ALL NULL today, and that is the point. This endpoint used to answer `available: false` and then report zero spam, zero malware and zero phishing -- which is not "no data", it is a clean bill of health. A customer charting it saw a flat green line and a customer alerting on it never alerted. Null says "we have not measured"; treat it as unknown, never as none.

    • scannedinteger

      Messages put through spam, malware and phishing detection. Null means the figure is unavailable, never that it is zero.

    • spaminteger

      Messages detection classified as spam. Null means the figure is unavailable, never that it is zero.

    • malwareinteger

      Messages detection found malware in. Null means the figure is unavailable, never that it is zero.

    • phishinginteger

      Messages detection classified as phishing. Null means the figure is unavailable, never that it is zero.

  • seriesarray<object>

    Null while `availability.state` is `unavailable`, which is always. Nothing produces security trend rows, so publishing `[]` would assert there were no incidents. When a detection engine exists these rows will carry the section's standard `start_at` plus the counts above; only `availability.state` and the nulls change.

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.