notecard-schema/card.usage.test.rsp.notecard.api.json at master · blues/notecard-schema · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
{
    "$schema": "https://json-schema.org/draft/2020-12/schema",
    "$id": "https://raw.githubusercontent.com/blues/notecard-schema/master/card.usage.test.rsp.notecard.api.json",
    "title": "card.usage.test Response Application Programming Interface (API) Schema",
    "description": "Response containing cellular data usage projection and analysis results.",
    "type": "object",
    "version": "1.1.2",
    "apiVersion": "9.1.1",
    "skus": [
        "CELL",
        "CELL+WIFI",
        "WIFI"
    ],
    "properties": {
        "bytes_per_day": {
            "description": "Average bytes per day used during the test period.",
            "type": "integer"
        },
        "bytes_received": {
            "description": "Number of bytes received by the Notecard from Notehub.",
            "type": "integer"
        },
        "bytes_sent": {
            "description": "Number of bytes sent by the Notecard to Notehub.",
            "type": "integer"
        },
        "days": {
            "description": "The number of days used for the test.",
            "type": "integer"
        },
        "max": {
            "description": "The days of projected data available based on test.",
            "type": "integer"
        },
        "notes_received": {
            "description": "Number of notes received by the Notecard from Notehub.",
            "type": "integer"
        },
        "notes_sent": {
            "description": "Number of notes sent by the Notecard to Notehub.",
            "type": "integer"
        },
        "seconds": {
            "description": "Number of seconds in the analyzed period.",
            "type": "integer"
        },
        "sessions_secure": {
            "description": "Number of secure Notehub sessions.",
            "type": "integer"
        },
        "sessions_standard": {
            "description": "Number of standard Notehub sessions.",
            "type": "integer"
        },
        "time": {
            "description": "Time of device activation.",
            "type": "integer"
        }
    },
    "unevaluatedProperties": false,
    "samples": [
        {
            "title": "Complete Usage Test Results",
            "description": "Example response showing comprehensive usage projection data.",
            "json": "{\"max\": 12730, \"days\": 7, \"bytes_per_day\": 41136, \"seconds\": 1291377, \"time\": 1598479763, \"bytes_sent\": 163577, \"bytes_received\": 454565, \"notes_sent\": 114, \"notes_received\": 26, \"sessions_standard\": 143, \"sessions_secure\": 31}"
        },
        {
            "title": "Basic Projection Results",
            "description": "Example response with essential projection metrics.",
            "json": "{\"max\": 1825, \"days\": 30, \"bytes_per_day\": 56832, \"seconds\": 2592000, \"time\": 1700000000}"
        }
    ]
}