Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TPageEndpoint

Endpoint class represents an Obelisk API Endpoint. You can just execute it, or request soms higher level function from it, like give me a range.

Hierarchy

  • TPageEndpoint

Index

Accessors

Methods

Accessors

url

  • get url(): string
  • Absolute url to use in requests

    Returns string

Methods

execute

  • Executes the call to the given endpoint. If the call requires authentication, it will add it. If the call requires extra handling because it defines a range of multple buckets, it will handle it.

    Returns Observable<TPageResponse>

Static create

  • Creates an TPageEndpoint instance, the client is used to add tokens and uri is relative path starting after /api/. Examples are: /things/my_thing/metrics/my_metric/events?from=1530089953000 or /locations/my_loc/metrics/my_metric/stats/unit

    Parameters

    Returns TPageEndpoint