Skip to content

Commit

Permalink
Adding readme updates for rate limit PR
Browse files Browse the repository at this point in the history
  • Loading branch information
choran committed Aug 29, 2017
1 parent e7dd6d1 commit fb126be
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -332,6 +332,15 @@ $client->notes->getNotes([
// Get a single Note by id
$client->notes->getNote("42");
```
## Rate Limits
Rate limit info is passed via the rate limit headers.
You can access this information as follows:
```
$rate_limit = $intercom->getRateLimitDetails();
print("{$rate_limit['remaining']} {$rate_limit['limit']} \n");
print_r($rate_limit['reset_at']->format(DateTime::ISO8601));
```
For more info on rate limits and these headers please see the [API ref docs](https://developers.intercom.com/reference#rate-limiting)

## Pagination

Expand Down

0 comments on commit fb126be

Please sign in to comment.