Skip to main content
GET
Get the sending limits of a line
  • Credential: an API key of the owner of the line. See Reading the limits and the queue.
  • Line-scoped keys: a line-scoped key gets 403 forbidden unless the line is in its list, even when the line does not exist.
  • Events: none.
  • Rolling windows: every counter counts over a rolling window and none resets at midnight. See The five limits.
  • *_frees_at: the time at which a counter drops back under its limit. null when the counter is under its limit, when the limit is 0, or when the time could not be computed: read null as “no known wait”.
  • Limits in force: the limits returned are the ones in force on the line. To change them, see Configuration.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

id
string
required

Id of a line: line_ followed by 25 letters or digits.

Pattern: ^line_[0-9A-Za-z]{25}$

Response

The sending limits of the line and their counters.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The sending limits of a line with their counters. Every counter covers a rolling window.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.