@mentio-dev/sdk 0.12.3 → 0.12.4
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/dist/index.d.ts +25 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2713,6 +2713,10 @@ type UsageBreakdown = {
|
|
|
2713
2713
|
* The dimension the rows are grouped by.
|
|
2714
2714
|
*/
|
|
2715
2715
|
by: 'day' | 'platform' | 'keyword' | 'group';
|
|
2716
|
+
/**
|
|
2717
|
+
* true when keywordIds, groupIds or platforms narrowed the report: totals and rows count only what passes them, except totals.ledgerDebitCents, which is the whole workspace's.
|
|
2718
|
+
*/
|
|
2719
|
+
filtered: boolean;
|
|
2716
2720
|
/**
|
|
2717
2721
|
* Every amount is in USD cents.
|
|
2718
2722
|
*/
|
|
@@ -2758,7 +2762,7 @@ type UsageBreakdown = {
|
|
|
2758
2762
|
*/
|
|
2759
2763
|
totalCents: number;
|
|
2760
2764
|
/**
|
|
2761
|
-
* What the ledger has debited so far for the days of the window, each debit by the day it settled. Mentions settle the morning after their day, so a window ending today lags totalCents by today's mentions (and yesterday's before the tick at 00:05 UTC); a closed month differs from totalCents only by cumulative rounding.
|
|
2765
|
+
* What the ledger has debited so far for the days of the window, each debit by the day it settled, for the whole workspace whatever the filters. Mentions settle the morning after their day, so a window ending today lags totalCents by today's mentions (and yesterday's before the tick at 00:05 UTC); a closed month differs from totalCents only by cumulative rounding.
|
|
2762
2766
|
*/
|
|
2763
2767
|
ledgerDebitCents: number;
|
|
2764
2768
|
/**
|
|
@@ -8453,6 +8457,26 @@ type GetUsageBreakdownData = {
|
|
|
8453
8457
|
* A calendar month (YYYY-MM, UTC) instead of a trailing window: from its first day to its last, or to today for the running month. A future month is a 400.
|
|
8454
8458
|
*/
|
|
8455
8459
|
month?: string;
|
|
8460
|
+
/**
|
|
8461
|
+
* First UTC day of a custom window, YYYY-MM-DD, inclusive; with `to` (default today). At most 366 days. Wins over `range` and `month`.
|
|
8462
|
+
*/
|
|
8463
|
+
from?: string;
|
|
8464
|
+
/**
|
|
8465
|
+
* Last UTC day of a custom window, YYYY-MM-DD, inclusive; never after today. Needs `from`.
|
|
8466
|
+
*/
|
|
8467
|
+
to?: string;
|
|
8468
|
+
/**
|
|
8469
|
+
* Only these keywords (kw_...), deleted ones included. Repeatable, or comma-separated.
|
|
8470
|
+
*/
|
|
8471
|
+
keywordIds?: Array<string> | null;
|
|
8472
|
+
/**
|
|
8473
|
+
* Only these groups (grp_...): a keyword-day by the group it was metered under, a mention or a comment by its keyword's group as it is now. Repeatable, or comma-separated.
|
|
8474
|
+
*/
|
|
8475
|
+
groupIds?: Array<string> | null;
|
|
8476
|
+
/**
|
|
8477
|
+
* Only these platforms. A keyword-day belongs to no platform, so with this filter the keyword line reads 0 and only mentions and comments count. Repeatable, or comma-separated.
|
|
8478
|
+
*/
|
|
8479
|
+
platforms?: Array<'bluesky' | 'hackernews' | 'github' | 'stackoverflow' | 'devto' | 'reddit' | 'x' | 'youtube' | 'news' | 'linkedin' | 'tiktok' | 'instagram' | 'appstore' | 'googleplay' | 'trustpilot' | 'googlemaps' | 'rss'>;
|
|
8456
8480
|
/**
|
|
8457
8481
|
* Rows per page, 1 to 500 (default 100). Only by=keyword can outgrow a page; a window has at most 90 days and a dozen platforms.
|
|
8458
8482
|
*/
|