sentisense 0.69.0 → 0.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -544,6 +544,9 @@ client.entityMetrics.getMetrics("AAPL", {
544
544
  maxDataPoints: 100,
545
545
  })
546
546
 
547
+ // Daily App Store ratings for a product entity with an app (an entity slug, not a ticker)
548
+ client.entityMetrics.getMetrics("Instagram", { metricType: "app_all_ratings_count" })
549
+
547
550
  // Share of mentions by source (valueType "SHARE_PERCENT")
548
551
  client.entityMetrics.getDistribution("AAPL", "mentions")
549
552
  client.entityMetrics.getDistribution("AAPL", "mentions", { dimension: "source" })
@@ -554,7 +557,9 @@ client.entityMetrics.getDistribution("AAPL", "sentiment")
554
557
 
555
558
  In a distribution, `valueType` says what each number is. For a count metric such as `mentions` or `creators` it is `"SHARE_PERCENT"`: each value is that source's percentage share of the total, summing to about 100. For `sentiment` it is `"MEAN"`: each value is that source's mean polarity over the window, in [-1, 1], the same numbers as `GET /api/v2/metrics/entity/{symbol}/metric/sentiment/mean-by/source` in the [API reference](https://sentisense.ai/docs/api/metrics/). `sentisense_score` has no per-source split and answers with an empty distribution.
556
559
 
557
- Available metric types: `mentions`, `sentiment`, `sentisense_score`, `sentisense_rating`, `social_dominance`, `creators`. `sentisense` is an alias for `sentisense_score`; either spelling returns the same series, and keys are case-insensitive. Responses always name the canonical type, so a `sentisense` request answers with `SENTISENSE_SCORE`. `sentisense_rating` is the SentiSense Rating score and is a time series only: it has no source breakdown, so `getDistribution` answers with an empty distribution for it.
560
+ Available metric types: `mentions`, `sentiment`, `sentisense_score`, `sentisense_rating`, `social_dominance`, `creators`, `app_review_count`, `app_rating`, `app_all_ratings_count`, `app_all_ratings_avg`. `sentisense` is an alias for `sentisense_score`; either spelling returns the same series, and keys are case-insensitive. Responses always name the canonical type, so a `sentisense` request answers with `SENTISENSE_SCORE`. `sentisense_rating` is the SentiSense Rating score and is a time series only: it has no source breakdown, so `getDistribution` answers with an empty distribution for it.
561
+
562
+ The four `app_` metrics are daily Apple App Store series for product entities that have an app, so pass an entity slug such as `"Instagram"` rather than a ticker. `app_review_count` and `app_rating` cover the written reviews published that day, a small share of all ratings whose stars skew lower; `app_all_ratings_count` and `app_all_ratings_avg` cover every new rating, star-only and written together, and have no point on a day with no net new ratings or when the store's totals fell. Over a range, weight each day's `app_all_ratings_avg` by `app_all_ratings_count` for the period average. Each point's flat `value` is the count or the average stars.
558
563
 
559
564
  ### Options
560
565
 
package/dist/cli.cjs CHANGED
@@ -1409,7 +1409,7 @@ var flowsCommand = {
1409
1409
  };
1410
1410
 
1411
1411
  // src/version.ts
1412
- var VERSION = "0.69.0";
1412
+ var VERSION = "0.71.0";
1413
1413
 
1414
1414
  // src/resources/analyst.ts
1415
1415
  var Analyst = class {
@@ -1763,7 +1763,10 @@ var EntityMetrics = class {
1763
1763
  *
1764
1764
  * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi",
1765
1765
  * case-insensitive; discover slugs via stocks.getEntities()).
1766
- * @param options Metric type and optional time range / resolution.
1766
+ * @param options Metric type and optional time range / resolution. The App Store metrics
1767
+ * (`app_review_count`, `app_rating`, `app_all_ratings_count`,
1768
+ * `app_all_ratings_avg`) apply to product entities with a tracked app, so pass
1769
+ * an entity slug such as "Instagram", not a ticker.
1767
1770
  */
1768
1771
  async getMetrics(symbol, options = {}) {
1769
1772
  const { metricType = "sentiment", startTime, endTime, maxDataPoints } = options;
package/dist/index.cjs CHANGED
@@ -434,7 +434,10 @@ var EntityMetrics = class {
434
434
  *
435
435
  * @param symbol Ticker symbol (e.g. "AAPL") or entity urlSlug (e.g. "Nancy-Pelosi",
436
436
  * case-insensitive; discover slugs via stocks.getEntities()).
437
- * @param options Metric type and optional time range / resolution.
437
+ * @param options Metric type and optional time range / resolution. The App Store metrics
438
+ * (`app_review_count`, `app_rating`, `app_all_ratings_count`,
439
+ * `app_all_ratings_avg`) apply to product entities with a tracked app, so pass
440
+ * an entity slug such as "Instagram", not a ticker.
438
441
  */
439
442
  async getMetrics(symbol, options = {}) {
440
443
  const { metricType = "sentiment", startTime, endTime, maxDataPoints } = options;
@@ -1472,7 +1475,7 @@ var Trackers = class {
1472
1475
  };
1473
1476
 
1474
1477
  // src/version.ts
1475
- var VERSION = "0.69.0";
1478
+ var VERSION = "0.71.0";
1476
1479
 
1477
1480
  // src/client.ts
1478
1481
  var DEFAULT_BASE_URL = "https://app.sentisense.ai";