MCPcopy Create free account

hub / github.com/algolia/algoliasearch-client-javascript / functions

Functions947 in github.com/algolia/algoliasearch-client-javascript

Functionget
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createMemoryCache.ts:7
Functionget
( key: Record<string, any> | string, defaultValue: () => Promise<TValue>, events: CacheEvent
packages/client-common/src/cache/createFallbackableCache.ts:13
Functionget
()
packages/client-common/src/__tests__/cache/browser-local-storage-cache.test.ts:7
Functionget
()
packages/client-common/src/__tests__/cache/fallbackable-cache.test.ts:12
FunctiongetABTest
* Retrieves the details for an A/B test by its ID. * * Required API Key ACLs: * - analytics * @param getABTest - The getABTest ob
packages/abtesting/src/abtestingV3Client.ts:631
FunctiongetABTest
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `GET /3/abtests/{id}`. Retrieves the details for an A/B test by its I
packages/client-abtesting/src/abtestingClient.ts:567
FunctiongetABTestSettings
* Retrieves the settings captured for each variant of an A/B test, and whether another active A/B test is using the control index. Settings are captu
packages/abtesting/src/abtestingV3Client.ts:697
FunctiongetABTestSettingsWithHTTPInfo
* Retrieves the settings captured for each variant of an A/B test, and whether another active A/B test is using the control index. Settings are captu
packages/abtesting/src/abtestingV3Client.ts:728
FunctiongetABTestWithHTTPInfo
* Retrieves the details for an A/B test by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requ
packages/abtesting/src/abtestingV3Client.ts:664
FunctiongetABTestWithHTTPInfo
* This endpoint is deprecated. Use the A/B Testing API v3 instead. Replaced by `GET /3/abtests/{id}`. Retrieves the details for an A/B test by its I
packages/client-abtesting/src/abtestingClient.ts:597
FunctiongetAddToCartRate
* Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed per
packages/client-analytics/src/analyticsClient.ts:401
FunctiongetAddToCartRateWithHTTPInfo
* Retrieves the add-to-cart rate for all your searches with at least one add-to-cart event, including a daily breakdown. By default, the analyzed per
packages/client-analytics/src/analyticsClient.ts:451
FunctiongetAgent
* Retrieve details of the specified agent. * * Required API Key ACLs: * - settings * @param getAgent - The getAgent object.
packages/agent-studio/src/agentStudioClient.ts:2028
FunctiongetAgentWithHTTPInfo
* Retrieve details of the specified agent. * * Resolves with the full HTTP response information: status code, headers (when the requester ca
packages/agent-studio/src/agentStudioClient.ts:2056
FunctiongetAllConfigs
* Retrieves all Query Suggestions configurations of your Algolia application. * * Required API Key ACLs: * - settings * @param re
packages/client-query-suggestions/src/querySuggestionsClient.ts:476
FunctiongetAllConfigsWithHTTPInfo
* Retrieves all Query Suggestions configurations of your Algolia application. * * Resolves with the full HTTP response information: status c
packages/client-query-suggestions/src/querySuggestionsClient.ts:500
FunctiongetAllowedDomain
* Get a single allowed domain by id. * * Required API Key ACLs: * - settings * @param getAllowedDomain - The getAllowedDomain obj
packages/agent-studio/src/agentStudioClient.ts:2086
FunctiongetAllowedDomainWithHTTPInfo
* Get a single allowed domain by id. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/agent-studio/src/agentStudioClient.ts:2122
FunctiongetApiKey
* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your applic
packages/client-search/src/searchClient.ts:2303
FunctiongetApiKeyWithHTTPInfo
* Gets the permissions and restrictions of an API key. When authenticating with the admin API key, you can request information for any of your applic
packages/client-search/src/searchClient.ts:2331
FunctiongetAppTask
* Checks the status of a given application task. * * Required API Key ACLs: * - editSettings * @param getAppTask - The getAppTask
packages/client-search/src/searchClient.ts:2360
FunctiongetAppTaskWithHTTPInfo
* Checks the status of a given application task. * * Resolves with the full HTTP response information: status code, headers (when the reques
packages/client-search/src/searchClient.ts:2388
FunctiongetAuthentication
* Retrieves an authentication resource by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSetting
packages/ingestion/src/ingestionClient.ts:1649
FunctiongetAuthenticationWithHTTPInfo
* Retrieves an authentication resource by its ID. * * Resolves with the full HTTP response information: status code, headers (when the reque
packages/ingestion/src/ingestionClient.ts:1685
FunctiongetAverageClickPosition
* Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked
packages/client-analytics/src/analyticsClient.ts:499
FunctiongetAverageClickPositionWithHTTPInfo
* Retrieves the average click position of your search results, including a daily breakdown. The average click position is the average of all clicked
packages/client-analytics/src/analyticsClient.ts:549
FunctiongetClickPositions
* Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tent
packages/client-analytics/src/analyticsClient.ts:597
FunctiongetClickPositionsWithHTTPInfo
* Retrieves the positions in the search results and their associated number of clicks. This lets you check how many clicks the first, second, or tent
packages/client-analytics/src/analyticsClient.ts:647
FunctiongetClickThroughRate
* Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed p
packages/client-analytics/src/analyticsClient.ts:695
FunctiongetClickThroughRateWithHTTPInfo
* Retrieves the click-through rate (CTR) for all your searches with at least one click event, including a daily breakdown. By default, the analyzed p
packages/client-analytics/src/analyticsClient.ts:745
FunctiongetClusterIncidents
* Retrieves known incidents for the selected clusters. * @param getClusterIncidents - The getClusterIncidents object. * @param getClusterInc
packages/monitoring/src/monitoringClient.ts:353
FunctiongetClusterIncidentsWithHTTPInfo
* Retrieves known incidents for the selected clusters. * * Resolves with the full HTTP response information: status code, headers (when the
packages/monitoring/src/monitoringClient.ts:381
FunctiongetClusterStatus
* Retrieves the status of selected clusters. * @param getClusterStatus - The getClusterStatus object. * @param getClusterStatus.clusters - S
packages/monitoring/src/monitoringClient.ts:407
FunctiongetClusterStatusWithHTTPInfo
* Retrieves the status of selected clusters. * * Resolves with the full HTTP response information: status code, headers (when the requester
packages/monitoring/src/monitoringClient.ts:432
FunctiongetComposition
* Retrieve a single composition in the current Algolia application. * * Required API Key ACLs: * - editSettings * - settings
packages/composition/src/compositionClient.ts:580
FunctiongetCompositionWithHTTPInfo
* Retrieve a single composition in the current Algolia application. * * Resolves with the full HTTP response information: status code, heade
packages/composition/src/compositionClient.ts:612
FunctiongetConfig
* Retrieves a list of configuration objects for each index. * * Required API Key ACLs: * - search * - browse * - recommend
packages/advanced-personalization/src/advancedPersonalizationClient.ts:489
FunctiongetConfig
* Retrieves a single Query Suggestions configuration by its index name. * * Required API Key ACLs: * - settings * @param getConfi
packages/client-query-suggestions/src/querySuggestionsClient.ts:526
FunctiongetConfigStatus
* Reports the status of a Query Suggestions index. * * Required API Key ACLs: * - settings * @param getConfigStatus - The getConf
packages/client-query-suggestions/src/querySuggestionsClient.ts:583
FunctiongetConfigStatusWithHTTPInfo
* Reports the status of a Query Suggestions index. * * Resolves with the full HTTP response information: status code, headers (when the requ
packages/client-query-suggestions/src/querySuggestionsClient.ts:611
FunctiongetConfigWithHTTPInfo
* Retrieves a list of configuration objects for each index. * * Resolves with the full HTTP response information: status code, headers (when
packages/advanced-personalization/src/advancedPersonalizationClient.ts:515
FunctiongetConfigWithHTTPInfo
* Retrieves a single Query Suggestions configuration by its index name. * * Resolves with the full HTTP response information: status code, h
packages/client-query-suggestions/src/querySuggestionsClient.ts:554
FunctiongetConfiguration
* Get Configuration. * * Required API Key ACLs: * - logs * @param requestOptions - The requestOptions to send along with the quer
packages/agent-studio/src/agentStudioClient.ts:2153
FunctiongetConfigurationWithHTTPInfo
* Get Configuration. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body
packages/agent-studio/src/agentStudioClient.ts:2177
FunctiongetConversation
* Retrieves the conversation and its messages for the given ID. * * Required API Key ACLs: * - logs * @param getConversation - Th
packages/agent-studio/src/agentStudioClient.ts:2208
FunctiongetConversationWithHTTPInfo
* Retrieves the conversation and its messages for the given ID. * * Resolves with the full HTTP response information: status code, headers (
packages/agent-studio/src/agentStudioClient.ts:2271
FunctiongetConversionRate
* Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed
packages/client-analytics/src/analyticsClient.ts:793
FunctiongetConversionRateWithHTTPInfo
* Retrieves the conversion rate (CR) for all your searches with at least one conversion event, including a daily breakdown. By default, the analyzed
packages/client-analytics/src/analyticsClient.ts:843
FunctiongetDestination
* Retrieves a destination by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings * @par
packages/ingestion/src/ingestionClient.ts:1719
FunctiongetDestinationWithHTTPInfo
* Retrieves a destination by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requester captures
packages/ingestion/src/ingestionClient.ts:1752
FunctiongetDictionaryLanguages
* Lists supported languages with their supported dictionary types and number of custom entries. * * Required API Key ACLs: * - setting
packages/client-search/src/searchClient.ts:2415
FunctiongetDictionaryLanguagesWithHTTPInfo
* Lists supported languages with their supported dictionary types and number of custom entries. * * Resolves with the full HTTP response inf
packages/client-search/src/searchClient.ts:2439
FunctiongetDictionarySettings
* Retrieves the languages for which standard dictionary entries are turned off. * * Required API Key ACLs: * - settings * @param
packages/client-search/src/searchClient.ts:2463
FunctiongetDictionarySettingsWithHTTPInfo
* Retrieves the languages for which standard dictionary entries are turned off. * * Resolves with the full HTTP response information: status
packages/client-search/src/searchClient.ts:2487
FunctiongetEvent
* Retrieves a single task run event by its ID. * * Required API Key ACLs: * - addObject * - deleteIndex * - editSettings
packages/ingestion/src/ingestionClient.ts:1787
FunctiongetEventWithHTTPInfo
* Retrieves a single task run event by its ID. * * Resolves with the full HTTP response information: status code, headers (when the requeste
packages/ingestion/src/ingestionClient.ts:1822
FunctiongetIncidents
* Retrieves known incidents for all clusters. * @param requestOptions - The requestOptions to send along with the query, they will be merged with
packages/monitoring/src/monitoringClient.ts:456
FunctiongetIncidentsWithHTTPInfo
* Retrieves known incidents for all clusters. * * Resolves with the full HTTP response information: status code, headers (when the requester
packages/monitoring/src/monitoringClient.ts:477
FunctiongetIndexingTime
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. Th
packages/monitoring/src/monitoringClient.ts:500
FunctiongetIndexingTimeWithHTTPInfo
* Retrieves indexing latency metrics for selected clusters. This endpoint is intended for infrastructure-level monitoring and availability checks. Th
packages/monitoring/src/monitoringClient.ts:528
FunctiongetLatency
* Retrieves the average latency for search requests for selected clusters. * @param getLatency - The getLatency object. * @param getLatency.
packages/monitoring/src/monitoringClient.ts:554
FunctiongetLatencyWithHTTPInfo
* Retrieves the average latency for search requests for selected clusters. * * Resolves with the full HTTP response information: status code
packages/monitoring/src/monitoringClient.ts:579
FunctiongetLogFile
* Retrieves the logs for a single Query Suggestions index. * * Required API Key ACLs: * - settings * @param getLogFile - The getL
packages/client-query-suggestions/src/querySuggestionsClient.ts:640
FunctiongetLogFileWithHTTPInfo
* Retrieves the logs for a single Query Suggestions index. * * Resolves with the full HTTP response information: status code, headers (when
packages/client-query-suggestions/src/querySuggestionsClient.ts:668
FunctiongetLogs
* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)
packages/client-search/src/searchClient.ts:2516
FunctiongetLogsWithHTTPInfo
* The request must be authenticated by an API key with the [`logs` ACL](https://www.algolia.com/doc/guides/security/api-keys/#access-control-list-acl)
packages/client-search/src/searchClient.ts:2564
FunctiongetMetrics
* Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [P
packages/monitoring/src/monitoringClient.ts:606
FunctiongetMetricsWithHTTPInfo
* Retrieves metrics related to your Algolia infrastructure, aggregated over a selected time window. Access to this API is available as part of the [P
packages/monitoring/src/monitoringClient.ts:636
FunctiongetNoClickRate
* Retrieves the fraction of searches whose query didn\'t lead to any click within a time range, including a daily breakdown. Only tracked searches wit
packages/client-analytics/src/analyticsClient.ts:891
FunctiongetNoClickRateWithHTTPInfo
* Retrieves the fraction of searches whose query didn\'t lead to any click within a time range, including a daily breakdown. Only tracked searches wit
packages/client-analytics/src/analyticsClient.ts:941
FunctiongetNoResultsRate
* Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of se
packages/client-analytics/src/analyticsClient.ts:989
FunctiongetNoResultsRateWithHTTPInfo
* Retrieves the fraction of searches that didn\'t return any results within a time range, including a daily breakdown. It also returns the count of se
packages/client-analytics/src/analyticsClient.ts:1039
FunctiongetObject
* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/
packages/client-search/src/searchClient.ts:2609
FunctiongetObjectWithHTTPInfo
* Retrieves one record by its object ID. To retrieve more than one record, use the [`objects` operation](https://www.algolia.com/doc/rest-api/search/
packages/client-search/src/searchClient.ts:2650
FunctiongetObjects
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. * * Required A
packages/client-search/src/searchClient.ts:2686
FunctiongetObjectsWithHTTPInfo
* Retrieves one or more records, potentially from different indices. Records are returned in the same order as the requests. * * Resolves w
packages/client-search/src/searchClient.ts:2718
FunctiongetPatternsFields
* Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required
packages/client-analytics/src/analyticsClient.ts:1079
FunctiongetPatternsFieldsWithHTTPInfo
* Returns the static catalog of analytics fields, grouped by domain and usage (metrics, filters, groups, distributions). No authentication is required
packages/client-analytics/src/analyticsClient.ts:1100
FunctiongetPersonalizationStrategy
* Retrieves the current personalization strategy. * * Required API Key ACLs: * - recommendation * @param requestOptions - The req
packages/client-personalization/src/personalizationClient.ts:415
FunctiongetPersonalizationStrategyWithHTTPInfo
* Retrieves the current personalization strategy. * * Resolves with the full HTTP response information: status code, headers (when the reque
packages/client-personalization/src/personalizationClient.ts:439
FunctiongetProvider
* Get Provider. * * Required API Key ACLs: * - settings * @param getProvider - The getProvider object. * @param getProvider.
packages/agent-studio/src/agentStudioClient.ts:2327
FunctiongetProviderWithHTTPInfo
* Get Provider. * * Resolves with the full HTTP response information: status code, headers (when the requester captures them), raw body and
packages/agent-studio/src/agentStudioClient.ts:2361
FunctiongetPurchaseRate
* Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period in
packages/client-analytics/src/analyticsClient.ts:1127
FunctiongetPurchaseRateWithHTTPInfo
* Retrieves the purchase rate for all your searches with at least one purchase event, including a daily breakdown. By default, the analyzed period in
packages/client-analytics/src/analyticsClient.ts:1177
FunctiongetReachability
* Test whether clusters are reachable or not. * @param getReachability - The getReachability object. * @param getReachability.clusters - Sub
packages/monitoring/src/monitoringClient.ts:666
FunctiongetReachabilityWithHTTPInfo
* Test whether clusters are reachable or not. * * Resolves with the full HTTP response information: status code, headers (when the requester
packages/monitoring/src/monitoringClient.ts:694
FunctiongetRealtimeUser
* Retrieves the real-time user\'s personalization profiles containing search filters. * * Required API Key ACLs: * - recommendation
packages/advanced-personalization/src/advancedPersonalizationClient.ts:541
FunctiongetRealtimeUserWithHTTPInfo
* Retrieves the real-time user\'s personalization profiles containing search filters. * * Resolves with the full HTTP response information:
packages/advanced-personalization/src/advancedPersonalizationClient.ts:569
FunctiongetRecommendRule
* Retrieves a Recommend rule that you previously created in the Algolia dashboard. * * Required API Key ACLs: * - settings * @par
packages/recommend/src/recommendClient.ts:542
FunctiongetRecommendRuleWithHTTPInfo
* Retrieves a Recommend rule that you previously created in the Algolia dashboard. * * Resolves with the full HTTP response information: sta
packages/recommend/src/recommendClient.ts:582
FunctiongetRecommendStatus
* Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed de
packages/recommend/src/recommendClient.ts:620
FunctiongetRecommendStatusWithHTTPInfo
* Checks the status of a given task. Deleting a Recommend rule is asynchronous. When you delete a rule, a task is created on a queue and completed de
packages/recommend/src/recommendClient.ts:660
FunctiongetRecommendations
* Retrieves recommendations from selected AI models. * * Required API Key ACLs: * - search * @param getRecommendationsParams - Th
packages/recommend/src/recommendClient.ts:695
FunctiongetRecommendations
* Retrieves recommendations from selected AI models. * * Required API Key ACLs: * - search * @param getRecommendationsParams - Th
packages/algoliasearch/lite/src/liteClient.ts:242
FunctiongetRecommendationsWithHTTPInfo
* Retrieves recommendations from selected AI models. * * Resolves with the full HTTP response information: status code, headers (when the re
packages/recommend/src/recommendClient.ts:738
FunctiongetRecommendationsWithHTTPInfo
* Retrieves recommendations from selected AI models. * * Resolves with the full HTTP response information: status code, headers (when the re
packages/algoliasearch/lite/src/liteClient.ts:285
FunctiongetRevenue
* Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events.
packages/client-analytics/src/analyticsClient.ts:1225
FunctiongetRevenueWithHTTPInfo
* Retrieves revenue-related metrics, such as the total revenue or the average order value. To retrieve revenue-related metrics, send purchase events.
packages/client-analytics/src/analyticsClient.ts:1275
FunctiongetRule
* Retrieves a rule by its ID. To find the object ID of rules, use the [`search` operation](https://www.algolia.com/doc/rest-api/search/search-rules).
packages/client-search/src/searchClient.ts:2753
FunctiongetRule
* Retrieves a rule by its ID. To find the object ID of a rule, use the [`search` operation](https://www.algolia.com/doc/rest-api/composition/search-c
packages/composition/src/compositionClient.ts:646
← previousnext →501–600 of 947, ranked by callers