Skip to content

Commit 7556c8e

Browse files
algolia-botKeylor42
andcommitted
docs(personalization): add rate limit information for personalization API (#4725) (generated) [skip ci]
Co-authored-by: Keylor42 <[email protected]>
1 parent ae2d0f0 commit 7556c8e

File tree

45 files changed

+274
-118
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+274
-118
lines changed

clients/algoliasearch-client-csharp/algoliasearch/Clients/PersonalizationConfiguration.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
/*
22
* Personalization API
33
*
4-
* The Personalization API lets you access user profiles built from the personalization strategy. ## Base URLs The base URLs for requests to the Personalization API are: - `https://personalization.us.algolia.com` - `https://personalization.eu.algolia.com` Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ## Version The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
4+
* The Personalization API lets you access user profiles built from the personalization strategy. ## Base URLs The base URLs for requests to the Personalization API are: - `https://personalization.us.algolia.com` - `https://personalization.eu.algolia.com` Use the URL that matches your [analytics region](https://dashboard.algolia.com/account/infrastructure/analytics). **All requests must use HTTPS.** ## Authentication To authenticate your API requests, add these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the necessary permissions to make the request. The required access control list (ACL) to make a request is listed in each endpoint's reference. You can find your application ID and API key in the [Algolia dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message` property with more information. ## Rate limiting When making requests to the Personalization API, you are limited to 40 API calls per second per application. The following headers provide information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. - `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
55
*
66
* The version of the OpenAPI document: 1.0.0
77
* Generated by: https://github.com/openapitools/openapi-generator.git

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/DeleteUserProfileResponse.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/ErrorBase.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/EventType.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/EventsScoring.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/FacetsScoring.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/GetUserTokenResponse.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/JsonSupport.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/PersonalizationStrategyParams.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

clients/algoliasearch-client-scala/src/main/scala/algoliasearch/personalization/SetPersonalizationStrategyResponse.scala

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,12 @@
99
* be JSON objects. ## Response status and errors The Personalization API returns JSON responses. Since JSON doesn't
1010
* guarantee any specific ordering, don't rely on the order of attributes in the API response. Successful responses
1111
* return a `2xx` status. Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error
12-
* responses have a `message` property with more information. ## Version The current version of the Personalization API
13-
* is version 1, as indicated by the `/1/` in each endpoint's URL.
12+
* responses have a `message` property with more information. ## Rate limiting When making requests to the
13+
* Personalization API, you are limited to 40 API calls per second per application. The following headers provide
14+
* information about your current limit: - `x-ratelimit-limit`: The number of requests allowed every second. -
15+
* `x-ratelimit-remaining`: The number of requests remaining in the current second period. - `x-ratelimit-reset`: [Unix
16+
* timestamp](https://www.unixtimestamp.com/) of the next time period. ## Version The current version of the
17+
* Personalization API is version 1, as indicated by the `/1/` in each endpoint's URL.
1418
*
1519
* The version of the OpenAPI document: 1.0.0
1620
*

0 commit comments

Comments
 (0)