Conventions


Each service described in this chapter includes an “Access Info” table. This table provides the endpoint (URL) where the service is accessible, as well as the type of service access keys that the service accepts.

Date and time conventions

The following date-specific conventions apply to all services:

  1. All date and time references across SBS are in the GMT time zone, unless specified otherwise in the description of each field.

  2. Many services provide filters where you can supply a “from” and “to” date as input. Importantly, the “from” and “to” values may be of type Date or DateTime.

    If “from” and “to” are of type Date, then the “to” date is inclusive. For example, the filter

    
        {
           "createdAt": {
                "from": "2024-01-01",
                "to": "2024-01-02",
            }
        }
        
    

    will return data created on 2024-01-01 and also on 2024-01-02.

    However, if “from” and “to” are of type DateTime, and if you supply only a date value without time, the time is implicitly considered to be 00:00:00. This means that the filter

    
        {
           "createdAt": {
                "from": "2024-01-01",
                "to": "2024-01-02",
            }
        }
        
    

    will NOT return data created on 2024-01-02. To retrieve this data as well, make sure to supply the to time value explicitly, for example:

    
        {
           "createdAt": {
                "from": "2024-01-01",
                "to": "2024-01-02T23:59:59.999Z",
            }
        }