API Rate Limits

This article will outline the rate limitations we have set in place to provide the best experience when using our API.

Our API and assets are available via a content delivery network (CDN) which is distributed globally. The server closest to your user will serve all content and assets, thus minimizing latency and benefitting your website or application.

What We'll Cover

Basic API Information

API Rate Limits

Content Link Depth

Bandwidth Restrictions

Basic API Information

Our API is available at:

api.aglty.io (for our USA Data Center)

or

ca-api.aglty.io (for our Canadian Data Center)

API Rate Limits

Our rate limits determine the number of requests a client can make to our API in a certain amount of time. All requests have a per-second rate limit.

If your response is cached on our CDN, it will not count towards your rate limit. Our API enforces a limit of 10 direct requests per 1 second.

  • When there are too many requests (more than 10 requests in a second), we will respond with a status code of 429:
    Too Many Requests.
  • When the request for a response times out after 30 seconds, we respond with a status code of 408:
    The request took too long to process.

Content Link Depth

When fetching content that contains Linked Content, you'll notice that the API may return a reference name instead of the actual content you were expecting. We do this to ensure you're not always over-fetching content.

Depending on how deeply linked your Content Architecture is, we provide a ContentLinkDepth query parameter for our API that lets you define how much Linked Content you would like to fetch.

The default value for ContentLinkDepth is 1, and the maximum value that can be passed is 5.

ContentLinkDepth works in conjunction with the query parameter ExpandAllContentLinks. If set to true, Linked Content will be expanded in the response.

Example 1

ContentLinkDepth = 1

EpandAllContentLinks = false

https:/api.aglty.io/{GUID}/fetch/en-us/list/example?ContentLinkDepth=1&ExpandAllContentLinks=false

This request will return the following response:

{
  "items": [
    {
      "contentID": 94,
      "properties": {},
      "fields": {
        "field": {
          "referencename": "example1"
        }
      }
    }
  ],
  "totalCount": 1
}

Example 2

ContentLinkDepth = 1

EpandAllContentLinks = true

https:/api.aglty.io/{GUID}/fetch/en-us/list/example?ContentLinkDepth=1&ExpandAllContentLinks=true

This request will return the following response:

{
  "items": [
    {
      "contentID": 94,
      "properties": {},
      "fields": {
        "field": [
          {
            "contentID": 95,
            "properties": {},
            "fields": {
              "field": {
                "referencename": "example2"
              }
            }
          }
        ]
      }
    }
  ],
  "totalCount": 1
}

Example 3

ContentLinkDepth = 2

EpandAllContentLinks = true

https:/api.aglty.io/{GUID}/fetch/en-us/list/example?ContentLinkDepth=2&ExpandAllContentLinks=true

This request will return the following response:

{
  "items": [
    {
      "contentID": 94,
      "properties": {},
      "fields": {
        "field": [
          {
            "contentID": 95,
            "properties": {},
            "fields": {
              "field": [
                {
                  "contentID": 96,
                  "properties": {},
                  "fields": {
                    "field": {
                      "referencename": "example3"
                    }
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "totalCount": 1
}

Bandwidth Restrictions

We have Bandwidth Restrictions set in place to monitor your total bandwidth of assets and API calls available per month. To view more information on Bandwidth Restrictions, refer to our Pricing page.

2 out of 2 found this helpful

Comments

0 comments

Please sign in to leave a comment.