influship 0.2.0 → 0.3.2

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.
Files changed (262) hide show
  1. package/CHANGELOG.md +62 -30
  2. package/LICENSE +1 -1
  3. package/README.md +88 -43
  4. package/client.d.mts +49 -29
  5. package/client.d.mts.map +1 -1
  6. package/client.d.ts +49 -29
  7. package/client.d.ts.map +1 -1
  8. package/client.js +89 -56
  9. package/client.js.map +1 -1
  10. package/client.mjs +89 -56
  11. package/client.mjs.map +1 -1
  12. package/core/api-promise.d.mts +2 -2
  13. package/core/api-promise.d.mts.map +1 -1
  14. package/core/api-promise.d.ts +2 -2
  15. package/core/api-promise.d.ts.map +1 -1
  16. package/core/api-promise.js.map +1 -1
  17. package/core/api-promise.mjs.map +1 -1
  18. package/core/error.d.mts +2 -2
  19. package/core/error.d.mts.map +1 -1
  20. package/core/error.d.ts +2 -2
  21. package/core/error.d.ts.map +1 -1
  22. package/core/error.js +4 -4
  23. package/core/error.js.map +1 -1
  24. package/core/error.mjs +2 -2
  25. package/core/error.mjs.map +1 -1
  26. package/core/pagination.d.mts +75 -0
  27. package/core/pagination.d.mts.map +1 -0
  28. package/core/pagination.d.ts +75 -0
  29. package/core/pagination.d.ts.map +1 -0
  30. package/core/pagination.js +139 -0
  31. package/core/pagination.js.map +1 -0
  32. package/core/pagination.mjs +132 -0
  33. package/core/pagination.mjs.map +1 -0
  34. package/core/resource.d.mts +3 -3
  35. package/core/resource.d.mts.map +1 -1
  36. package/core/resource.d.ts +3 -3
  37. package/core/resource.d.ts.map +1 -1
  38. package/core/resource.js.map +1 -1
  39. package/core/resource.mjs.map +1 -1
  40. package/index.d.mts +4 -3
  41. package/index.d.mts.map +1 -1
  42. package/index.d.ts +4 -3
  43. package/index.d.ts.map +1 -1
  44. package/index.js +6 -4
  45. package/index.js.map +1 -1
  46. package/index.mjs +4 -3
  47. package/index.mjs.map +1 -1
  48. package/internal/parse.d.mts +2 -2
  49. package/internal/parse.d.mts.map +1 -1
  50. package/internal/parse.d.ts +2 -2
  51. package/internal/parse.d.ts.map +1 -1
  52. package/internal/parse.js +5 -0
  53. package/internal/parse.js.map +1 -1
  54. package/internal/parse.mjs +5 -0
  55. package/internal/parse.mjs.map +1 -1
  56. package/internal/shims.js +1 -1
  57. package/internal/shims.js.map +1 -1
  58. package/internal/shims.mjs +1 -1
  59. package/internal/shims.mjs.map +1 -1
  60. package/internal/tslib.js +17 -17
  61. package/internal/uploads.d.mts +4 -4
  62. package/internal/uploads.d.mts.map +1 -1
  63. package/internal/uploads.d.ts +4 -4
  64. package/internal/uploads.d.ts.map +1 -1
  65. package/internal/uploads.js.map +1 -1
  66. package/internal/uploads.mjs.map +1 -1
  67. package/internal/utils/base64.js +2 -2
  68. package/internal/utils/base64.js.map +1 -1
  69. package/internal/utils/base64.mjs +3 -3
  70. package/internal/utils/base64.mjs.map +1 -1
  71. package/internal/utils/log.d.mts +3 -3
  72. package/internal/utils/log.d.mts.map +1 -1
  73. package/internal/utils/log.d.ts +3 -3
  74. package/internal/utils/log.d.ts.map +1 -1
  75. package/internal/utils/log.js.map +1 -1
  76. package/internal/utils/log.mjs.map +1 -1
  77. package/internal/utils/path.js +1 -1
  78. package/internal/utils/path.js.map +1 -1
  79. package/internal/utils/path.mjs +2 -2
  80. package/internal/utils/path.mjs.map +1 -1
  81. package/internal/utils/query.d.mts +2 -0
  82. package/internal/utils/query.d.mts.map +1 -0
  83. package/internal/utils/query.d.ts +2 -0
  84. package/internal/utils/query.d.ts.map +1 -0
  85. package/internal/utils/query.js +10 -0
  86. package/internal/utils/query.js.map +1 -0
  87. package/internal/utils/query.mjs +6 -0
  88. package/internal/utils/query.mjs.map +1 -0
  89. package/internal/utils/values.js +5 -5
  90. package/internal/utils/values.js.map +1 -1
  91. package/internal/utils/values.mjs +6 -6
  92. package/internal/utils/values.mjs.map +1 -1
  93. package/internal/utils.d.mts +1 -0
  94. package/internal/utils.d.ts +1 -0
  95. package/internal/utils.js +1 -0
  96. package/internal/utils.js.map +1 -1
  97. package/internal/utils.mjs +1 -0
  98. package/package.json +24 -3
  99. package/pagination.d.mts +2 -0
  100. package/pagination.d.mts.map +1 -0
  101. package/pagination.d.ts +2 -0
  102. package/pagination.d.ts.map +1 -0
  103. package/pagination.js +6 -0
  104. package/pagination.js.map +1 -0
  105. package/pagination.mjs +2 -0
  106. package/pagination.mjs.map +1 -0
  107. package/resources/creators.d.mts +326 -247
  108. package/resources/creators.d.mts.map +1 -1
  109. package/resources/creators.d.ts +326 -247
  110. package/resources/creators.d.ts.map +1 -1
  111. package/resources/creators.js +80 -63
  112. package/resources/creators.js.map +1 -1
  113. package/resources/creators.mjs +80 -63
  114. package/resources/creators.mjs.map +1 -1
  115. package/resources/health.d.mts +13 -1
  116. package/resources/health.d.mts.map +1 -1
  117. package/resources/health.d.ts +13 -1
  118. package/resources/health.d.ts.map +1 -1
  119. package/resources/health.js +4 -1
  120. package/resources/health.js.map +1 -1
  121. package/resources/health.mjs +4 -1
  122. package/resources/health.mjs.map +1 -1
  123. package/resources/index.d.mts +6 -7
  124. package/resources/index.d.mts.map +1 -1
  125. package/resources/index.d.ts +6 -7
  126. package/resources/index.d.ts.map +1 -1
  127. package/resources/index.js +5 -7
  128. package/resources/index.js.map +1 -1
  129. package/resources/index.mjs +2 -3
  130. package/resources/index.mjs.map +1 -1
  131. package/resources/posts.d.mts +82 -202
  132. package/resources/posts.d.mts.map +1 -1
  133. package/resources/posts.d.ts +82 -202
  134. package/resources/posts.d.ts.map +1 -1
  135. package/resources/posts.js +17 -38
  136. package/resources/posts.js.map +1 -1
  137. package/resources/posts.mjs +17 -38
  138. package/resources/posts.mjs.map +1 -1
  139. package/resources/profiles.d.mts +208 -58
  140. package/resources/profiles.d.mts.map +1 -1
  141. package/resources/profiles.d.ts +208 -58
  142. package/resources/profiles.d.ts.map +1 -1
  143. package/resources/profiles.js +37 -41
  144. package/resources/profiles.js.map +1 -1
  145. package/resources/profiles.mjs +37 -41
  146. package/resources/profiles.mjs.map +1 -1
  147. package/resources/raw/index.d.mts +4 -0
  148. package/resources/raw/index.d.mts.map +1 -0
  149. package/resources/raw/index.d.ts +4 -0
  150. package/resources/raw/index.d.ts.map +1 -0
  151. package/resources/raw/index.js +11 -0
  152. package/resources/raw/index.js.map +1 -0
  153. package/resources/raw/index.mjs +5 -0
  154. package/resources/raw/index.mjs.map +1 -0
  155. package/resources/raw/instagram.d.mts +215 -0
  156. package/resources/raw/instagram.d.mts.map +1 -0
  157. package/resources/raw/instagram.d.ts +215 -0
  158. package/resources/raw/instagram.d.ts.map +1 -0
  159. package/resources/raw/instagram.js +31 -0
  160. package/resources/raw/instagram.js.map +1 -0
  161. package/resources/raw/instagram.mjs +27 -0
  162. package/resources/raw/instagram.mjs.map +1 -0
  163. package/resources/raw/raw.d.mts +14 -0
  164. package/resources/raw/raw.d.mts.map +1 -0
  165. package/resources/raw/raw.d.ts +14 -0
  166. package/resources/raw/raw.d.ts.map +1 -0
  167. package/resources/raw/raw.js +21 -0
  168. package/resources/raw/raw.js.map +1 -0
  169. package/resources/raw/raw.mjs +16 -0
  170. package/resources/raw/raw.mjs.map +1 -0
  171. package/resources/raw/youtube.d.mts +455 -0
  172. package/resources/raw/youtube.d.mts.map +1 -0
  173. package/resources/raw/youtube.d.ts +455 -0
  174. package/resources/raw/youtube.d.ts.map +1 -0
  175. package/resources/raw/youtube.js +61 -0
  176. package/resources/raw/youtube.js.map +1 -0
  177. package/resources/raw/youtube.mjs +57 -0
  178. package/resources/raw/youtube.mjs.map +1 -0
  179. package/resources/raw.d.mts +2 -0
  180. package/resources/raw.d.mts.map +1 -0
  181. package/resources/raw.d.ts +2 -0
  182. package/resources/raw.d.ts.map +1 -0
  183. package/resources/raw.js +6 -0
  184. package/resources/raw.js.map +1 -0
  185. package/resources/raw.mjs +3 -0
  186. package/resources/raw.mjs.map +1 -0
  187. package/resources/search.d.mts +126 -117
  188. package/resources/search.d.mts.map +1 -1
  189. package/resources/search.d.ts +126 -117
  190. package/resources/search.d.ts.map +1 -1
  191. package/resources/search.js +46 -13
  192. package/resources/search.js.map +1 -1
  193. package/resources/search.mjs +46 -13
  194. package/resources/search.mjs.map +1 -1
  195. package/resources/shared.d.mts +55 -0
  196. package/resources/shared.d.mts.map +1 -0
  197. package/resources/shared.d.ts +55 -0
  198. package/resources/shared.d.ts.map +1 -0
  199. package/resources/shared.js +4 -0
  200. package/resources/shared.js.map +1 -0
  201. package/resources/shared.mjs +3 -0
  202. package/resources/shared.mjs.map +1 -0
  203. package/src/client.ts +153 -127
  204. package/src/core/api-promise.ts +4 -4
  205. package/src/core/error.ts +2 -2
  206. package/src/core/pagination.ts +232 -0
  207. package/src/core/resource.ts +3 -3
  208. package/src/index.ts +4 -3
  209. package/src/internal/parse.ts +8 -2
  210. package/src/internal/shims.ts +1 -1
  211. package/src/internal/uploads.ts +5 -5
  212. package/src/internal/utils/base64.ts +3 -3
  213. package/src/internal/utils/log.ts +3 -3
  214. package/src/internal/utils/path.ts +2 -2
  215. package/src/internal/utils/query.ts +7 -0
  216. package/src/internal/utils/values.ts +6 -6
  217. package/src/internal/utils.ts +1 -0
  218. package/src/pagination.ts +2 -0
  219. package/src/resources/creators.ts +369 -271
  220. package/src/resources/health.ts +13 -1
  221. package/src/resources/index.ts +22 -41
  222. package/src/resources/posts.ts +89 -232
  223. package/src/resources/profiles.ts +252 -59
  224. package/src/resources/raw/index.ts +16 -0
  225. package/src/resources/raw/instagram.ts +271 -0
  226. package/src/resources/raw/raw.ts +47 -0
  227. package/src/resources/raw/youtube.ts +585 -0
  228. package/src/resources/raw.ts +3 -0
  229. package/src/resources/search.ts +145 -131
  230. package/src/resources/shared.ts +66 -0
  231. package/src/version.ts +1 -1
  232. package/version.d.mts +1 -1
  233. package/version.d.ts +1 -1
  234. package/version.js +1 -1
  235. package/version.mjs +1 -1
  236. package/resources/brand-safety.d.mts +0 -234
  237. package/resources/brand-safety.d.mts.map +0 -1
  238. package/resources/brand-safety.d.ts +0 -234
  239. package/resources/brand-safety.d.ts.map +0 -1
  240. package/resources/brand-safety.js +0 -75
  241. package/resources/brand-safety.js.map +0 -1
  242. package/resources/brand-safety.mjs +0 -71
  243. package/resources/brand-safety.mjs.map +0 -1
  244. package/resources/lookalike.d.mts +0 -142
  245. package/resources/lookalike.d.mts.map +0 -1
  246. package/resources/lookalike.d.ts +0 -142
  247. package/resources/lookalike.d.ts.map +0 -1
  248. package/resources/lookalike.js +0 -28
  249. package/resources/lookalike.js.map +0 -1
  250. package/resources/lookalike.mjs +0 -24
  251. package/resources/lookalike.mjs.map +0 -1
  252. package/resources/match.d.mts +0 -90
  253. package/resources/match.d.mts.map +0 -1
  254. package/resources/match.d.ts +0 -90
  255. package/resources/match.d.ts.map +0 -1
  256. package/resources/match.js +0 -22
  257. package/resources/match.js.map +0 -1
  258. package/resources/match.mjs +0 -18
  259. package/resources/match.mjs.map +0 -1
  260. package/src/resources/brand-safety.ts +0 -304
  261. package/src/resources/lookalike.ts +0 -186
  262. package/src/resources/match.ts +0 -115
@@ -1,21 +1,19 @@
1
1
  "use strict";
2
2
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
- exports.Search = exports.Profiles = exports.Posts = exports.Match = exports.Lookalike = exports.Health = exports.Creators = exports.BrandSafety = void 0;
5
- var brand_safety_1 = require("./brand-safety.js");
6
- Object.defineProperty(exports, "BrandSafety", { enumerable: true, get: function () { return brand_safety_1.BrandSafety; } });
4
+ exports.Search = exports.Raw = exports.Profiles = exports.Posts = exports.Health = exports.Creators = void 0;
5
+ const tslib_1 = require("../internal/tslib.js");
6
+ tslib_1.__exportStar(require("./shared.js"), exports);
7
7
  var creators_1 = require("./creators.js");
8
8
  Object.defineProperty(exports, "Creators", { enumerable: true, get: function () { return creators_1.Creators; } });
9
9
  var health_1 = require("./health.js");
10
10
  Object.defineProperty(exports, "Health", { enumerable: true, get: function () { return health_1.Health; } });
11
- var lookalike_1 = require("./lookalike.js");
12
- Object.defineProperty(exports, "Lookalike", { enumerable: true, get: function () { return lookalike_1.Lookalike; } });
13
- var match_1 = require("./match.js");
14
- Object.defineProperty(exports, "Match", { enumerable: true, get: function () { return match_1.Match; } });
15
11
  var posts_1 = require("./posts.js");
16
12
  Object.defineProperty(exports, "Posts", { enumerable: true, get: function () { return posts_1.Posts; } });
17
13
  var profiles_1 = require("./profiles.js");
18
14
  Object.defineProperty(exports, "Profiles", { enumerable: true, get: function () { return profiles_1.Profiles; } });
15
+ var raw_1 = require("./raw/raw.js");
16
+ Object.defineProperty(exports, "Raw", { enumerable: true, get: function () { return raw_1.Raw; } });
19
17
  var search_1 = require("./search.js");
20
18
  Object.defineProperty(exports, "Search", { enumerable: true, get: function () { return search_1.Search; } });
21
19
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAWwB;AAVtB,2GAAA,WAAW,OAAA;AAWb,0CAYoB;AAXlB,oGAAA,QAAQ,OAAA;AAYV,sCAA4D;AAAnD,gGAAA,MAAM,OAAA;AACf,4CAKqB;AAJnB,sGAAA,SAAS,OAAA;AAKX,oCAMiB;AALf,8FAAA,KAAK,OAAA;AAMP,oCAQiB;AAPf,8FAAA,KAAK,OAAA;AAQP,0CAKoB;AAJlB,oGAAA,QAAQ,OAAA;AAKV,sCAKkB;AAJhB,gGAAA,MAAM,OAAA"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,sDAAyB;AACzB,0CAWoB;AAVlB,oGAAA,QAAQ,OAAA;AAWV,sCAA4D;AAAnD,gGAAA,MAAM,OAAA;AACf,oCAKiB;AAJf,8FAAA,KAAK,OAAA;AAKP,0CAUoB;AATlB,oGAAA,QAAQ,OAAA;AAUV,oCAAgC;AAAvB,0FAAA,GAAG,OAAA;AACZ,sCAQkB;AAPhB,gGAAA,MAAM,OAAA"}
@@ -1,10 +1,9 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
- export { BrandSafety, } from "./brand-safety.mjs";
2
+ export * from "./shared.mjs";
3
3
  export { Creators, } from "./creators.mjs";
4
4
  export { Health } from "./health.mjs";
5
- export { Lookalike, } from "./lookalike.mjs";
6
- export { Match, } from "./match.mjs";
7
5
  export { Posts, } from "./posts.mjs";
8
6
  export { Profiles, } from "./profiles.mjs";
7
+ export { Raw } from "./raw/raw.mjs";
9
8
  export { Search, } from "./search.mjs";
10
9
  //# sourceMappingURL=index.mjs.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,WAAW,GAUZ;OACM,EACL,QAAQ,GAWT;OACM,EAAE,MAAM,EAA4B;OACpC,EACL,SAAS,GAIV;OACM,EACL,KAAK,GAKN;OACM,EACL,KAAK,GAON;OACM,EACL,QAAQ,GAIT;OACM,EACL,MAAM,GAIP"}
1
+ {"version":3,"file":"index.mjs","sourceRoot":"","sources":["../src/resources/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;;OAG/E,EACL,QAAQ,GAUT;OACM,EAAE,MAAM,EAA4B;OACpC,EACL,KAAK,GAIN;OACM,EACL,QAAQ,GAST;OACM,EAAE,GAAG,EAAE;OACP,EACL,MAAM,GAOP"}
@@ -1,284 +1,164 @@
1
1
  import { APIResource } from "../core/resource.mjs";
2
- import * as BrandSafetyAPI from "./brand-safety.mjs";
3
- import { APIPromise } from "../core/api-promise.mjs";
2
+ import { PagePromise, QueryCursor, type QueryCursorParams } from "../core/pagination.mjs";
4
3
  import { RequestOptions } from "../internal/request-options.mjs";
4
+ /**
5
+ * Retrieve and analyze social media posts with engagement metrics, media content, and performance data.
6
+ */
5
7
  export declare class Posts extends APIResource {
6
8
  /**
7
- * Analyze a social media post for engagement metrics, content insights, and brand
8
- * safety.
9
- *
10
- * Provide post via URL or post_id+platform. Optionally include AI analysis and/or
11
- * brand safety features.
12
- *
13
- * **Pricing**:
9
+ * Retrieve posts for a creator or profile with engagement metrics and media data.
14
10
  *
15
- * - Base: 1.0 credit per post
16
- * - AI Analysis feature: +0.5 credits (includes summary and transcript)
17
- * - Brand Safety feature: +0.5 credits (includes rating and risk flags)
18
- * - **Example**: 1 post with both features = 1.0 + 0.5 + 0.5 = 2.0 credits
11
+ * **Query options:**
19
12
  *
20
- * @example
21
- * ```ts
22
- * const postAnalysis = await client.posts.analyze({
23
- * url: 'https://example.com',
24
- * });
25
- * ```
26
- */
27
- analyze(body: PostAnalyzeParams, options?: RequestOptions): APIPromise<PostAnalysis>;
28
- /**
29
- * Retrieve posts for a specific creator using cursor-based pagination.
13
+ * - By creator: Use `creator_id` to get posts across all their profiles
14
+ * - By profile: Use `platform` + `username` for a specific profile's posts
30
15
  *
31
- * This endpoint allows you to fetch posts from a creator's social media accounts
32
- * with optional analysis features and date filtering.
16
+ * **Sort options:**
33
17
  *
34
- * **Pricing**:
18
+ * - `recent`: Most recent posts first (default)
19
+ * - `top_engagement`: Highest engagement rate first
20
+ * - `most_likes`: Most likes first
21
+ * - `most_views`: Most views first (video content)
22
+ * - `most_comments`: Most comments first
35
23
  *
36
- * - Base: 0.01 credits per post returned
37
- * - The more posts you request, the more you pay
38
- * - Use the `limit` parameter to control costs
39
- * - **Example**: 25 posts = 0.25 credits
40
- * - **Example**: 100 posts = 1.0 credit
41
- *
42
- * @example
43
- * ```ts
44
- * const response = await client.posts.listByCreator();
45
- * ```
24
+ * **Pricing**: 0.05 credits per post returned ($0.0005)
46
25
  */
47
- listByCreator(query?: PostListByCreatorParams | null | undefined, options?: RequestOptions): APIPromise<PostListByCreatorResponse>;
26
+ list(query?: PostListParams | null | undefined, options?: RequestOptions): PagePromise<PostListResponsesQueryCursor, PostListResponse>;
48
27
  }
28
+ export type PostListResponsesQueryCursor = QueryCursor<PostListResponse>;
49
29
  /**
50
- * AI-powered content analysis. Only present when `ai_analysis` feature is
51
- * requested.
30
+ * Full post details
52
31
  */
53
- export interface AIAnalysis {
32
+ export interface PostListResponse {
54
33
  /**
55
- * AI-generated summary describing key themes, topics, and messaging.
34
+ * Post unique identifier
56
35
  */
57
- summary: string;
58
- /**
59
- * Transcription of spoken words in video. null for photo posts or videos without
60
- * speech.
61
- */
62
- transcript?: string | null;
63
- }
64
- /**
65
- * Cursor-based pagination metadata. Use this to navigate through paginated results
66
- * efficiently.
67
- */
68
- export interface CursorPagination {
36
+ id: string;
69
37
  /**
70
- * Indicates whether more results are available.
71
- *
72
- * - `true`: Additional pages exist, use the `cursor` to fetch them
73
- * - `false`: This is the last page of results
38
+ * Post caption
74
39
  */
75
- has_more: boolean;
40
+ caption: string | null;
76
41
  /**
77
- * Opaque base64-encoded cursor string for fetching the next page. Pass this value
78
- * as the `cursor` query parameter in your next request. null when `has_more` is
79
- * false (no more pages available). Do not attempt to decode or construct cursor
80
- * values manually.
42
+ * Hashtags used in the post
81
43
  */
82
- cursor?: string | null;
83
- }
84
- /**
85
- * Analysis result for a single social media post
86
- */
87
- export interface PostAnalysis {
44
+ hashtags: Array<string>;
88
45
  /**
89
- * Internal post ID
46
+ * Post location information
90
47
  */
91
- id: string;
48
+ location: PostListResponse.Location | null;
92
49
  /**
93
- * Creator information for a post
50
+ * Post media information
94
51
  */
95
- creator: PostAnalysis.Creator;
52
+ media: PostListResponse.Media;
96
53
  /**
97
- * Whether this post contains video content. true for video posts and reels, false
98
- * for photo posts.
54
+ * Usernames mentioned in the post
99
55
  */
100
- is_video: boolean;
56
+ mentions: Array<string>;
101
57
  /**
102
- * URL of the primary media file (image or video). For carousel posts, this is the
103
- * first item.
58
+ * Post engagement metrics
104
59
  */
105
- media_url: string;
60
+ metrics: PostListResponse.Metrics;
106
61
  /**
107
62
  * Social media platform
108
63
  */
109
- platform: 'instagram' | 'tiktok';
64
+ platform: 'instagram';
110
65
  /**
111
- * Platform-specific unique identifier for this post. Format varies by platform
112
- * (Instagram: numeric ID, TikTok: alphanumeric).
66
+ * Platform-specific post ID
113
67
  */
114
- platform_post_id: string;
68
+ platform_id: string;
115
69
  /**
116
- * ISO 8601 timestamp when the post was originally published.
70
+ * Post timestamp
117
71
  */
118
72
  posted_at: string;
119
73
  /**
120
- * Alt text or accessibility caption describing the media. Useful for understanding
121
- * image content. null if unavailable.
122
- */
123
- accessibility_caption?: string | null;
124
- /**
125
- * AI-powered content analysis. Only present when `ai_analysis` feature is
126
- * requested.
127
- */
128
- ai_analysis?: AIAnalysis;
129
- /**
130
- * Brand safety analysis results
131
- */
132
- brand_safety?: BrandSafetyAPI.BrandSafetyAnalysis;
133
- /**
134
- * Post caption text written by the creator. null if no caption was provided.
135
- */
136
- caption?: string | null;
137
- /**
138
- * Total comments on post. null if unavailable.
139
- */
140
- comments_count?: number | null;
141
- /**
142
- * Total likes on post. null if platform hides like counts or data unavailable.
143
- */
144
- likes_count?: number | null;
145
- /**
146
- * Array of all media URLs in this post. Contains multiple items for carousel
147
- * posts, single item for regular posts.
74
+ * Profile unique identifier
148
75
  */
149
- media_urls?: Array<string>;
76
+ profile_id: string;
150
77
  /**
151
- * ISO 8601 timestamp when we last scraped/updated this post's data. Metrics are
152
- * accurate as of this time.
78
+ * Type of post
153
79
  */
154
- scraped_at?: string;
80
+ type: 'image' | 'video' | 'carousel' | 'reel' | 'story';
155
81
  /**
156
- * Instagram shortcode used in post URLs (instagram.com/p/{shortcode}). Only
157
- * present for Instagram posts, null for other platforms.
82
+ * Post URL
158
83
  */
159
- shortcode?: string | null;
160
- /**
161
- * Thumbnail image URL for video posts. Only present when is_video is true, null
162
- * for photo posts.
163
- */
164
- thumbnail_url?: string | null;
165
- /**
166
- * Video length in seconds. null for photo posts.
167
- */
168
- video_duration_seconds?: number | null;
169
- /**
170
- * Video view count. null for photo posts or if unavailable.
171
- */
172
- video_view_count?: number | null;
84
+ url: string;
173
85
  }
174
- export declare namespace PostAnalysis {
86
+ export declare namespace PostListResponse {
175
87
  /**
176
- * Creator information for a post
88
+ * Post location information
177
89
  */
178
- interface Creator {
179
- /**
180
- * Creator UUID
181
- */
182
- id: string;
90
+ interface Location {
183
91
  /**
184
- * Social media platform
92
+ * Location name
185
93
  */
186
- platform: 'instagram' | 'tiktok';
187
- /**
188
- * Social media username
189
- */
190
- username: string;
94
+ name: string | null;
191
95
  }
192
- }
193
- /**
194
- * Response for getting posts by creator
195
- */
196
- export interface PostListByCreatorResponse {
197
- /**
198
- * Cursor-based pagination metadata. Use this to navigate through paginated results
199
- * efficiently.
200
- */
201
- pagination: CursorPagination;
202
96
  /**
203
- * Array of posts
97
+ * Post media information
204
98
  */
205
- posts: Array<PostAnalysis>;
206
- }
207
- export type PostAnalyzeParams = PostAnalyzeParams.Variant0 | PostAnalyzeParams.Variant1;
208
- export declare namespace PostAnalyzeParams {
209
- interface Variant0 {
99
+ interface Media {
210
100
  /**
211
- * Public URL of the post to analyze
101
+ * Video duration in seconds
212
102
  */
213
- url: string;
103
+ duration_seconds: number | null;
214
104
  /**
215
- * Analysis features to include
105
+ * Thumbnail URL
216
106
  */
217
- features?: Array<'ai_analysis' | 'brand_safety'>;
107
+ thumbnail_url: string | null;
218
108
  /**
219
- * Social media platform (required when using post_id)
109
+ * Media URL
220
110
  */
221
- platform?: 'instagram' | 'tiktok';
111
+ url: string | null;
222
112
  /**
223
- * Platform-specific post ID
113
+ * Video URL (for video content)
224
114
  */
225
- post_id?: string;
115
+ video_url: string | null;
226
116
  }
227
- interface Variant1 {
117
+ /**
118
+ * Post engagement metrics
119
+ */
120
+ interface Metrics {
228
121
  /**
229
- * Social media platform
122
+ * Comment count
230
123
  */
231
- platform: 'instagram' | 'tiktok';
124
+ comments: number | null;
232
125
  /**
233
- * Platform-specific post ID
126
+ * Engagement rate for this post as a percentage (e.g. 3.8 means 3.8%)
234
127
  */
235
- post_id: string;
128
+ engagement_rate: number | null;
236
129
  /**
237
- * Analysis features to include
130
+ * Like count
238
131
  */
239
- features?: Array<'ai_analysis' | 'brand_safety'>;
132
+ likes: number | null;
240
133
  /**
241
- * Public URL of the post to analyze
134
+ * Share count
242
135
  */
243
- url?: string;
136
+ shares: number | null;
137
+ /**
138
+ * View count (for video content)
139
+ */
140
+ views: number | null;
244
141
  }
245
142
  }
246
- export interface PostListByCreatorParams {
143
+ export interface PostListParams extends QueryCursorParams {
247
144
  /**
248
- * Creator UUID
145
+ * Creator ID (use this OR platform+username)
249
146
  */
250
147
  creator_id?: string;
251
148
  /**
252
- * Opaque pagination cursor from previous response. Do not construct manually.
253
- */
254
- cursor?: string;
255
- /**
256
- * Start date for filtering posts (ISO 8601)
149
+ * Platform (required with username)
257
150
  */
258
- date_from?: string;
151
+ platform?: 'instagram';
259
152
  /**
260
- * End date for filtering posts (ISO 8601)
261
- */
262
- date_to?: string;
263
- /**
264
- * Optional analysis features. `ai_analysis` adds summary/transcript.
265
- * `brand_safety` adds rating/flags. Each feature has additional cost.
266
- */
267
- features?: Array<'ai_analysis' | 'brand_safety'>;
268
- /**
269
- * Number of posts per page. Min 1, max 100, default 25.
270
- */
271
- limit?: number;
272
- /**
273
- * Social media platform
153
+ * Sort order
274
154
  */
275
- platform?: 'instagram' | 'tiktok';
155
+ sort?: 'recent' | 'top_engagement' | 'most_likes' | 'most_views' | 'most_comments';
276
156
  /**
277
- * Social media username
157
+ * Username (required with platform)
278
158
  */
279
159
  username?: string;
280
160
  }
281
161
  export declare namespace Posts {
282
- export { type AIAnalysis as AIAnalysis, type CursorPagination as CursorPagination, type PostAnalysis as PostAnalysis, type PostListByCreatorResponse as PostListByCreatorResponse, type PostAnalyzeParams as PostAnalyzeParams, type PostListByCreatorParams as PostListByCreatorParams, };
162
+ export { type PostListResponse as PostListResponse, type PostListResponsesQueryCursor as PostListResponsesQueryCursor, type PostListParams as PostListParams, };
283
163
  }
284
164
  //# sourceMappingURL=posts.d.mts.map
@@ -1 +1 @@
1
- {"version":3,"file":"posts.d.mts","sourceRoot":"","sources":["../src/resources/posts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,cAAc;OACnB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,OAAO,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,YAAY,CAAC;IAIpF;;;;;;;;;;;;;;;;;;OAkBG;IACH,aAAa,CACX,KAAK,GAAE,uBAAuB,GAAG,IAAI,GAAG,SAAc,EACtD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAGzC;AAED;;;GAGG;AACH,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC5B;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;OAKG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC;IAE9B;;;OAGG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,WAAW,GAAG,QAAQ,CAAC;IAEjC;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC;;;OAGG;IACH,WAAW,CAAC,EAAE,UAAU,CAAC;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,cAAc,CAAC,mBAAmB,CAAC;IAElD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,sBAAsB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAClC;AAED,yBAAiB,YAAY,CAAC;IAC5B;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,QAAQ,EAAE,WAAW,GAAG,QAAQ,CAAC;QAEjC;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;KAClB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;;OAGG;IACH,UAAU,EAAE,gBAAgB,CAAC;IAE7B;;OAEG;IACH,KAAK,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;CAC5B;AAED,MAAM,MAAM,iBAAiB,GAAG,iBAAiB,CAAC,QAAQ,GAAG,iBAAiB,CAAC,QAAQ,CAAC;AAExF,MAAM,CAAC,OAAO,WAAW,iBAAiB,CAAC;IACzC,UAAiB,QAAQ;QACvB;;WAEG;QACH,GAAG,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;QAEjD;;WAEG;QACH,QAAQ,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;QAElC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED,UAAiB,QAAQ;QACvB;;WAEG;QACH,QAAQ,EAAE,WAAW,GAAG,QAAQ,CAAC;QAEjC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;QAEjD;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,CAAC,EAAE,KAAK,CAAC,aAAa,GAAG,cAAc,CAAC,CAAC;IAEjD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,GAAG,QAAQ,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,UAAU,IAAI,UAAU,EAC7B,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}
1
+ {"version":3,"file":"posts.d.mts","sourceRoot":"","sources":["../src/resources/posts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,WAAW,EAAE,WAAW,EAAE,KAAK,iBAAiB,EAAE;OACpD,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;;;;;;OAiBG;IACH,IAAI,CACF,KAAK,GAAE,cAAc,GAAG,IAAI,GAAG,SAAc,EAC7C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,4BAA4B,EAAE,gBAAgB,CAAC;CAG/D;AAED,MAAM,MAAM,4BAA4B,GAAG,WAAW,CAAC,gBAAgB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,QAAQ,EAAE,gBAAgB,CAAC,QAAQ,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,gBAAgB,CAAC,KAAK,CAAC;IAE9B;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAExB;;OAEG;IACH,OAAO,EAAE,gBAAgB,CAAC,OAAO,CAAC;IAElC;;OAEG;IACH,QAAQ,EAAE,WAAW,CAAC;IAEtB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,OAAO,CAAC;IAExD;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED,yBAAiB,gBAAgB,CAAC;IAChC;;OAEG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;KACrB;IAED;;OAEG;IACH,UAAiB,KAAK;QACpB;;WAEG;QACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;QAEhC;;WAEG;QACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;QAE7B;;WAEG;QACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;QAEnB;;WAEG;QACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;KAC1B;IAED;;OAEG;IACH,UAAiB,OAAO;QACtB;;WAEG;QACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;QAExB;;WAEG;QACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;QAE/B;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;QAErB;;WAEG;QACH,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;QAEtB;;WAEG;QACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;KACtB;CACF;AAED,MAAM,WAAW,cAAe,SAAQ,iBAAiB;IACvD;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,WAAW,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,QAAQ,GAAG,gBAAgB,GAAG,YAAY,GAAG,YAAY,GAAG,eAAe,CAAC;IAEnF;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,cAAc,IAAI,cAAc,GACtC,CAAC;CACH"}