@brandazine/solari-sdk 0.2.3 → 0.2.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 +1 -1
- package/dist/index.js +1 -1
- package/dist/tools.generated.d.ts +10 -10
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2,7 +2,7 @@ import type { SolariToolMap, SolariToolName, SolariTools, SolariToolsWithoutRequ
|
|
|
2
2
|
export * from "./tools.generated.js";
|
|
3
3
|
export declare const DEFAULT_BASE_URL = "https://solari.sh";
|
|
4
4
|
export declare const API_PREFIX = "/mcp/api/v1";
|
|
5
|
-
export declare const SDK_VERSION = "0.2.
|
|
5
|
+
export declare const SDK_VERSION = "0.2.4";
|
|
6
6
|
export declare const TOKEN_ENV = "SOLARI_TOKEN";
|
|
7
7
|
export interface SolariTool {
|
|
8
8
|
name: string;
|
package/dist/index.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
export * from "./tools.generated.js";
|
|
2
2
|
export const DEFAULT_BASE_URL = "https://solari.sh";
|
|
3
3
|
export const API_PREFIX = "/mcp/api/v1";
|
|
4
|
-
export const SDK_VERSION = "0.2.
|
|
4
|
+
export const SDK_VERSION = "0.2.4";
|
|
5
5
|
export const TOKEN_ENV = "SOLARI_TOKEN";
|
|
6
6
|
const DEFAULT_TIMEOUT_MS = 150_000;
|
|
7
7
|
export class SolariError extends Error {
|
|
@@ -476,7 +476,7 @@ export interface InsightInstagramHashtagTrendingArgs {
|
|
|
476
476
|
/** Entries kept per list, default 30. Values above 100 are clamped to 100; top_total and rising_total give the full sizes. */
|
|
477
477
|
"limit"?: number | undefined;
|
|
478
478
|
}
|
|
479
|
-
/** Brand leaderboard for a market: brands ranked by how the content that tags or mentions them performs — total views by default, or views per post, post count, creator count, likes, sponsored views or organic views. Each row
|
|
479
|
+
/** Brand leaderboard for a market: brands ranked by how the content that tags or mentions them performs — total views by default, or views per post, post count, creator count, likes, sponsored views or organic views. Each row splits that content into sponsored and organic (not sponsored): sponsored_post_count, sponsored_total_plays and sponsored_median_plays for the sponsored part, organic_post_count, organic_total_plays and organic_median_plays for the rest, and sponsored_share (sponsored posts over all posts). Answer organic-only questions from this split, and get organic example posts from solari_insight_instagram_ranking_posts with kind=organic. Narrow to a category with scope; pass a brand to get its own rank as me, or find_username to locate any brand. Data is a daily snapshot (snapshot_at). Works with any signed-in SOLARI account. */
|
|
480
480
|
export interface InsightInstagramRankingBrandsArgs {
|
|
481
481
|
/** Market. */
|
|
482
482
|
"region"?: "KR" | "JP" | "US" | undefined;
|
|
@@ -499,7 +499,7 @@ export interface InsightInstagramRankingBrandsArgs {
|
|
|
499
499
|
/** Pagination offset, default 0. */
|
|
500
500
|
"offset"?: number | undefined;
|
|
501
501
|
}
|
|
502
|
-
/** Creator leaderboard for a market: creators who make brand-tagged content, ranked within a category so a specialist is not beaten by a large account with one post in it. Sort by total views, views per post, likes, number of brands worked with, sponsored views, reach (views per follower), lift (views per post against the creator's own usual median) or one-month view growth; the last three are null when a creator's baseline is too small. Each row
|
|
502
|
+
/** Creator leaderboard for a market: creators who make brand-tagged content, ranked within a category so a specialist is not beaten by a large account with one post in it. Sort by total views, views per post, likes, number of brands worked with, sponsored views, reach (views per follower), lift (views per post against the creator's own usual median) or one-month view growth; the last three are null when a creator's baseline is too small. Each row splits the creator's content into sponsored and organic the same way as the brand board: sponsored_* and organic_* post counts, total views and views per post, plus sponsored_share. kind=magazine ranks magazine and media accounts instead. Brand-owned, agency and shop accounts are excluded. Data is a daily snapshot (snapshot_at). Works with any signed-in SOLARI account. */
|
|
503
503
|
export interface InsightInstagramRankingCreatorsArgs {
|
|
504
504
|
/** Market (the creator's own region). */
|
|
505
505
|
"region"?: "KR" | "JP" | undefined;
|
|
@@ -526,7 +526,7 @@ export interface InsightInstagramRankingCreatorsArgs {
|
|
|
526
526
|
/** Pagination offset, default 0. */
|
|
527
527
|
"offset"?: number | undefined;
|
|
528
528
|
}
|
|
529
|
-
/** Where one Instagram account stands, without knowing whether it is a brand or a creator: for each board it appears on (brand, creator), its rank, pool size and top percentile in every category it belongs to, plus its overall row. Ranked by total views with the loosest filters. A side is null when the account is not on that board. Works with any signed-in SOLARI account. */
|
|
529
|
+
/** Where one Instagram account stands, without knowing whether it is a brand or a creator: for each board it appears on (brand, creator), its rank, pool size and top percentile in every category it belongs to, plus its overall row with the sponsored and organic split (organic_post_count, organic_total_plays, organic_median_plays, sponsored_share). The quickest way to answer how one brand's organic content performs. Ranked by total views with the loosest filters. A side is null when the account is not on that board. Works with any signed-in SOLARI account. */
|
|
530
530
|
export interface InsightInstagramRankingFindArgs {
|
|
531
531
|
/** Instagram handle, with or without a leading @. */
|
|
532
532
|
"username": string;
|
|
@@ -535,7 +535,7 @@ export interface InsightInstagramRankingFindArgs {
|
|
|
535
535
|
/** Window in days: 30 or 90. */
|
|
536
536
|
"days"?: number | undefined;
|
|
537
537
|
}
|
|
538
|
-
/** The best-performing posts behind one leaderboard row — the evidence for a brand's or creator's number — each marked sponsored or not. Pass the row's account_id with the same board, region, days (and scope for creators) the list used
|
|
538
|
+
/** The best-performing posts behind one leaderboard row — the evidence for a brand's or creator's number — each marked sponsored or not. Pass the row's account_id with the same board, region, days (and scope for creators) the list used. kind=sponsored keeps the sponsored subset; kind=organic keeps the posts that are not sponsored. A row keeps its top 6 posts by views, so kind=organic returns the organic ones among those (checked_top_posts says how many were checked) and can come back short or empty when sponsored posts fill the top. Works with any signed-in SOLARI account. */
|
|
539
539
|
export interface InsightInstagramRankingPostsArgs {
|
|
540
540
|
/** Which leaderboard the row came from. */
|
|
541
541
|
"board": "brand" | "creator";
|
|
@@ -547,8 +547,8 @@ export interface InsightInstagramRankingPostsArgs {
|
|
|
547
547
|
"days"?: number | undefined;
|
|
548
548
|
/** Creator board only: the same scope the list used. Omitted: 'all'. */
|
|
549
549
|
"scope"?: string | undefined;
|
|
550
|
-
/**
|
|
551
|
-
"kind"?: "all" | "sponsored" | undefined;
|
|
550
|
+
/** all = the row's top posts, sponsored = its top sponsored posts, organic = its top posts that are not sponsored. */
|
|
551
|
+
"kind"?: "all" | "sponsored" | "organic" | undefined;
|
|
552
552
|
/** Maximum posts, default 6. Values above 12 are clamped to 12. */
|
|
553
553
|
"limit"?: number | undefined;
|
|
554
554
|
}
|
|
@@ -794,13 +794,13 @@ export interface SolariTools {
|
|
|
794
794
|
trending<T = unknown>(args?: InsightInstagramHashtagTrendingArgs): Promise<T>;
|
|
795
795
|
};
|
|
796
796
|
ranking: {
|
|
797
|
-
/** Brand leaderboard for a market: brands ranked by how the content that tags or mentions them performs — total views by default, or views per post, post count, creator count, likes, sponsored views or organic views. Each row
|
|
797
|
+
/** Brand leaderboard for a market: brands ranked by how the content that tags or mentions them performs — total views by default, or views per post, post count, creator count, likes, sponsored views or organic views. Each row splits that content into sponsored and organic (not sponsored): sponsored_post_count, sponsored_total_plays and sponsored_median_plays for the sponsored part, organic_post_count, organic_total_plays and organic_median_plays for the rest, and sponsored_share (sponsored posts over all posts). Answer organic-only questions from this split, and get organic example posts from solari_insight_instagram_ranking_posts with kind=organic. Narrow to a category with scope; pass a brand to get its own rank as me, or find_username to locate any brand. Data is a daily snapshot (snapshot_at). Works with any signed-in SOLARI account. */
|
|
798
798
|
brands<T = unknown>(args?: InsightInstagramRankingBrandsArgs): Promise<T>;
|
|
799
|
-
/** Creator leaderboard for a market: creators who make brand-tagged content, ranked within a category so a specialist is not beaten by a large account with one post in it. Sort by total views, views per post, likes, number of brands worked with, sponsored views, reach (views per follower), lift (views per post against the creator's own usual median) or one-month view growth; the last three are null when a creator's baseline is too small. Each row
|
|
799
|
+
/** Creator leaderboard for a market: creators who make brand-tagged content, ranked within a category so a specialist is not beaten by a large account with one post in it. Sort by total views, views per post, likes, number of brands worked with, sponsored views, reach (views per follower), lift (views per post against the creator's own usual median) or one-month view growth; the last three are null when a creator's baseline is too small. Each row splits the creator's content into sponsored and organic the same way as the brand board: sponsored_* and organic_* post counts, total views and views per post, plus sponsored_share. kind=magazine ranks magazine and media accounts instead. Brand-owned, agency and shop accounts are excluded. Data is a daily snapshot (snapshot_at). Works with any signed-in SOLARI account. */
|
|
800
800
|
creators<T = unknown>(args?: InsightInstagramRankingCreatorsArgs): Promise<T>;
|
|
801
|
-
/** Where one Instagram account stands, without knowing whether it is a brand or a creator: for each board it appears on (brand, creator), its rank, pool size and top percentile in every category it belongs to, plus its overall row. Ranked by total views with the loosest filters. A side is null when the account is not on that board. Works with any signed-in SOLARI account. */
|
|
801
|
+
/** Where one Instagram account stands, without knowing whether it is a brand or a creator: for each board it appears on (brand, creator), its rank, pool size and top percentile in every category it belongs to, plus its overall row with the sponsored and organic split (organic_post_count, organic_total_plays, organic_median_plays, sponsored_share). The quickest way to answer how one brand's organic content performs. Ranked by total views with the loosest filters. A side is null when the account is not on that board. Works with any signed-in SOLARI account. */
|
|
802
802
|
find<T = unknown>(args: InsightInstagramRankingFindArgs): Promise<T>;
|
|
803
|
-
/** The best-performing posts behind one leaderboard row — the evidence for a brand's or creator's number — each marked sponsored or not. Pass the row's account_id with the same board, region, days (and scope for creators) the list used
|
|
803
|
+
/** The best-performing posts behind one leaderboard row — the evidence for a brand's or creator's number — each marked sponsored or not. Pass the row's account_id with the same board, region, days (and scope for creators) the list used. kind=sponsored keeps the sponsored subset; kind=organic keeps the posts that are not sponsored. A row keeps its top 6 posts by views, so kind=organic returns the organic ones among those (checked_top_posts says how many were checked) and can come back short or empty when sponsored posts fill the top. Works with any signed-in SOLARI account. */
|
|
804
804
|
posts<T = unknown>(args: InsightInstagramRankingPostsArgs): Promise<T>;
|
|
805
805
|
};
|
|
806
806
|
};
|
package/package.json
CHANGED