Gathering detailed insights and metrics for search-insights
Gathering detailed insights and metrics for search-insights
Library for reporting click, conversion and view metrics using the Algolia Insights API
Installations
npm install search-insightsDeveloper
algolia
Developer Guide
BETA
Module System
CommonJS, ESM, UMD
Min. Node Version
Typescript Support
Yes
Node Version
18.17.1
NPM Version
9.6.7
Statistics
53 Stars
445 Commits
18 Forks
55 Watching
6 Branches
268 Contributors
Updated on 18 Nov 2024
Bundle Size
13.01 kB
Minified
3.86 kB
Minified + Gzipped
Languages
TypeScript (96.11%)
JavaScript (3.55%)
Shell (0.34%)
Total Downloads
Cumulative downloads
Total Downloads
49,904,528
Last day
-2.7%
149,374
Compared to previous day
Last week
5.9%
787,603
Compared to previous week
Last month
12%
3,186,645
Compared to previous month
Last year
145.4%
30,849,692
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dev Dependencies
35
@babel/core@babel/eslint-parser@rollup/plugin-buble@rollup/plugin-commonjs@rollup/plugin-json@rollup/plugin-node-resolve@rollup/plugin-replace@rollup/plugin-typescript@types/istanbul-reports@types/jest@types/jsdom@types/node@typescript-eslint/eslint-plugin@typescript-eslint/parserbundlesize2eslinteslint-config-algoliaeslint-config-prettiereslint-plugin-eslint-commentseslint-plugin-importeslint-plugin-jsdoceslint-plugin-prettierjestjest-environment-jsdomjest-fetch-mockjest-localstorage-mockjest-watch-typeaheadmarkdown-tocprettierrolluprollup-plugin-filesizerollup-plugin-uglifyshipjsts-jesttypescript
Versions
Search Insights
Search Insights lets you report click, conversion and view metrics using the Algolia Insights API.
Table of Contents
NOTE: You're looking at the documentation of
search-insightsv2. (Click here for v1.x documentation.)
Notices
Cookie usage
v2 introduces a breaking change which is useCookie being false by default.
Payload validation
Since v2.0.4, search-insights no longer validates event payloads. You can visit https://algolia.com/events/debugger instead.
Getting started
We have created dedicated integrations for Google Tag Manager and Segment. If you are using either of these platforms, it is recommended to use the dedicated integrations to manage sending events to the Insights API.
Browser
For information on how to set up search-insights.js in a browser environment, see our documentation on Installing and Initializing the Insights Client.
We also have documentation for using search-insights.js with InstantSearch and Autocomplete.
- For information on using
search-insights.jswith InstantSearch, see our documentation on Sending click and conversion events with InstantSearch.js. - For information on using
search-insights.jswith Autocomplete, see our documentation on Sending Algolia Insights events with Autocomplete.
NOTE: If you are using Require.js, see our Note for Require.js users.
Node.js
For information on how to set up search-insights.js in a Node.js environment, see our guide on Installing and Initializing the Insights Client for Node.js.
Documentation
Documentation for search-insights.js can be found in our main Algolia Docs website.
For API Client reference information, see the Insights API Client Documentation.
Contributing
To run the examples and the code, you need to run two separate commands:
yarn devruns webpack and the Node.js serveryarn build:devruns Rollup in watch mode
Releasing
For information on releasing, see RELEASE.md.
License
Search Insights is MIT licensed.
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE.md:0
- Info: FSF or OSI recognized license: MIT License: LICENSE.md:0
Reason
Found 25/26 approved changesets -- score normalized to 9
Reason
7 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 6
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 29 are checked with a SAST tool
Reason
22 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-4w2v-q235-vp99
- Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x
- Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c
- Warn: Project is vulnerable to: GHSA-ff7x-qrg7-qggm
- Warn: Project is vulnerable to: GHSA-ghr5-ch3p-vcr6
- Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q
- Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c
- Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc
- Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp
- Warn: Project is vulnerable to: GHSA-78xj-cgh5-2h22
- Warn: Project is vulnerable to: GHSA-2p57-rm9w-gvfp
- Warn: Project is vulnerable to: GHSA-6c8f-qphg-qjgp
- Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-hxcc-f52p-wc94
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-7p7h-4mm5-852v
- Warn: Project is vulnerable to: GHSA-p9pc-299p-vxgp
Score
4.2
/10
Last Scanned on 2024-11-25
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More