Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions specs/abtesting-v3/spec.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
openapi: 3.0.2
externalDocs:
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
description: |
Related guide: A/B testing.
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing
description: A/B testing.
info:
title: A/B Testing API
description: |
Expand Down
5 changes: 2 additions & 3 deletions specs/abtesting/spec.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
openapi: 3.0.2
externalDocs:
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing/
description: |
Related guide: A/B testing.
url: https://www.algolia.com/doc/guides/ab-testing/what-is-ab-testing
description: A/B testing.
info:
title: A/B Testing API
description: |
Expand Down
14 changes: 7 additions & 7 deletions specs/advanced-personalization/spec.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ info:
## Client libraries

Use Algolia's API clients and libraries to reliably integrate Algolia's APIs with your apps.
The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla/).
The official API clients are covered by Algolia's [Service Level Agreement](https://www.algolia.com/policies/sla).

See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/)
See: [Algolia's ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem)

## Base URLs

Expand Down Expand Up @@ -51,7 +51,7 @@ info:

- `x-ratelimit-limit`: The number of requests allowed every 60 seconds.
- `x-ratelimit-remaining`: The number of requests remaining in the current 60 second period.
- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com/) of the next time period.
- `x-ratelimit-reset`: [Unix timestamp](https://www.unixtimestamp.com) of the next time period.

## Version

Expand All @@ -72,7 +72,8 @@ servers:
enum: [eu, us]
default: eu
externalDocs:
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization
description: What is Advanced Personalization.
security:
- appId: []
apiKey: []
Expand All @@ -91,9 +92,8 @@ tags:

User profiles contain the affinities each user has for the different facets in your index.
externalDocs:
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles/
description: |
Related guide: User Profiles.
url: https://www.algolia.com/doc/guides/personalization/ai-personalization/what-is-ai-personalization/concepts/user-profiles
description: User profiles.
x-tagGroups:
- name: Advanced Personalization
tags:
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/common/parameters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ Tags:

You can combine multiple tags with `OR` and `AND`.
Tags must be URL-encoded.
For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments/).
For more information, see [Segment your analytics data](https://www.algolia.com/doc/guides/search-analytics/guides/segments).
example: 'device:mobile%20phone'
schema:
type: string
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getAddToCartRate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ get:
**There's a difference between a 0 and null add-to-cart rate when `clickAnalytics` is enabled:**

- **Null** means there were no queries: since Algolia didn't receive any events, the add-to-cart rate is null.
- **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0** mean there _were_ queries but no [add-to-cart events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getAverageClickPosition.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ get:
For example, if users only ever click on the first result for any search, the average click position is 1.
By default, the analyzed period includes the last eight days including the current day.

An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
An average of `null` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries.
The average is `null` until Algolia receives at least one click event.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getClickPositions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ get:

This lets you check how many clicks the first, second, or tenth search results receive.

An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) for the queries.
An average of `0` when `clickAnalytics` is enabled means Algolia didn't receive any [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) for the queries.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getClickThroughRate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ get:
**There's a difference between a 0 and null CTR when `clickAnalytics` is enabled:**

- **Null** means there were no queries: since Algolia didn't receive any events, CTR is null.
- **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0** mean there _were_ queries but no [click events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getConversionRate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ get:
**There's a difference between a 0 and null CR when `clickAnalytics` is enabled:**

- **Null** means there were no queries: since Algolia didn't receive any events, CR is null.
- **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0** mean there _were_ queries but no [conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/click/getPurchaseRate.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ get:
**There's a difference between a 0 and null purchase rate when `clickAnalytics` is enabled:**

- **Null** means there were no queries: since Algolia didn't receive any events, the purchase rate is null.
- **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0** mean there _were_ queries but no [purchase conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopFiltersNoResults.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ get:
description: |
Retrieves the 1,000 most frequently used filters for a search that didn't return any results.

To get the most frequent searches without results, use the [Retrieve searches without results](#tag/search/operation/getSearchesNoResults) operation.
To get the most frequent searches without results, use the [Retrieve searches without results](https://www.algolia.com/doc/rest-api/analytics/get-searches-no-results) operation.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/Search'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopHits.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ get:
**There's a difference between 0% rates and null rates:**

- **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null.
- **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/Search'
Expand Down
2 changes: 1 addition & 1 deletion specs/analytics/paths/search/getTopSearches.yml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ get:
**There's a difference between 0% rates and null rates:**

- **Null** means there were no queries: since Algolia didn't receive any events, the rates (CTR, CR, ATCR, purchase rate) are null.
- **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started/) were received.
- **0% rates** mean there _were_ queries but no [click or conversion events](https://www.algolia.com/doc/guides/sending-events/getting-started) were received.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../common/parameters.yml#/ClickAnalytics'
Expand Down
7 changes: 3 additions & 4 deletions specs/analytics/paths/search/getUsersCount.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,12 @@ get:
Since it returns the number of unique users, the sum of the daily values might be different from the total number.

By default:

- Algolia distinguishes search users by their IP address, _unless_ you include a pseudonymous user identifier in your search requests with the `userToken` API parameter or `x-algolia-usertoken` request header.
- The analyzed period includes the last eight days including the current day.
externalDocs:
url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken/
description: |
Related guide: Distinguish users for analytics.
url: https://www.algolia.com/doc/guides/search-analytics/guides/usertoken
description: Distinguish users for analytics.
parameters:
- $ref: '../../../common/parameters.yml#/Index'
- $ref: '../../../common/parameters.yml#/StartDate'
Expand Down
7 changes: 3 additions & 4 deletions specs/analytics/spec.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
openapi: 3.0.2
externalDocs:
url: https://www.algolia.com/doc/guides/search-analytics/overview/
description: |
Related guide: Search analytics.
url: https://www.algolia.com/doc/guides/search-analytics/overview
description: Search analytics.
info:
title: Analytics API
description: |
Expand Down Expand Up @@ -64,7 +63,7 @@ info:
To ensure you have relevant analytics data, however, the series of keystrokes is aggregated to keep only the latest (final) user query.
This is called "prefix" aggregation.

For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation/).
For more information, see [Query agggregation and processing](https://www.algolia.com/doc/guides/search-analytics/concepts/query-aggregation).

See the analytics implementation overview for more information about query aggregation.
version: 2.0.0
Expand Down
4 changes: 2 additions & 2 deletions specs/common/parameters.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ hitsPerPage:
description: |
Maximum number of hits per page.

Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).
Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).

- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.
- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.
Expand All @@ -151,7 +151,7 @@ page:
description: |
Requested page of the API response.

Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js/)).
Algolia uses `page` and `hitsPerPage` to control how search results are displayed ([paginated](https://www.algolia.com/doc/guides/building-search-ui/ui-and-ux-patterns/pagination/js)).

- `hitsPerPage`: sets the number of search results (_hits_) displayed per page.
- `page`: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is `page=0`, the second is `page=1`, and so on.
Expand Down
5 changes: 3 additions & 2 deletions specs/common/responses/common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,9 @@ taskID:
description: |
Unique identifier of a task.

A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.

A successful API response means that a task was added to a queue.
It might not run immediately.
You can check the task's progress with the [`task` operation](https://www.algolia.com/doc/rest-api/search/get-task) and this task ID.
objectIDs:
type: array
items:
Expand Down
Loading