You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
@@ -90,19 +90,19 @@ Find apps and look up their identity. Other commands take the app IDs these retu
90
90
91
91
| Command | Description |
92
92
| ------- | ----------- |
93
-
| <ahref="#command-apps-search"><code>af apps search</code></a> | Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings; pass `--all-stores` to include other storefronts. To filter apps by estimate values (e.g. apps with >100k downloads last month) use [`explorer query`](#command-explorer-query). For estimates broken down by time, country, or storefront, use [`metrics query`](#command-metrics-query) with datasets estimates.sales or estimates.revenue. |
93
+
| <ahref="#command-apps-search"><code>af apps search</code></a> | Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings; pass `--all-stores` to include other storefronts. To filter apps by estimate values (e.g. apps with >100k downloads last month) use [`explorer list-products`](#command-explorer-list-products). For estimates broken down by time, country, or storefront, use [`metrics query`](#command-metrics-query) with datasets estimates.sales or estimates.revenue. |
94
94
| <ahref="#command-apps-tracked"><code>af apps tracked</code></a> | List the apps your Appfigures account tracks. |
95
95
| <ahref="#command-apps-get"><code>af apps get</code></a> | Get an app's record: basic metadata (name, developer, etc) and, if the user tracks it, what data they can access. Pass a product ID for one storefront; unified app ID for all storefronts together. |
96
96
97
97
### Explorer
98
98
99
-
Search and analyze the app catalog: 3M+ apps and 120+ fields spanning identity, storefront and country availability, categories, ratings, release dates, chart ranks, download and revenue estimates, SDK presence, demographics, and related apps.
99
+
Search and analyze the full app catalog: millions of products across Apple, Google Play, Amazon, and other major stores, with 120+ fields spanning identity, storefront and country availability, categories, ratings, release dates, chart ranks, download and revenue estimates, SDK presence, demographics, and related apps.
100
100
101
101
| Command | Description |
102
102
| ------- | ----------- |
103
-
| <ahref="#command-explorer-query"><code>af explorer query</code></a> | Read catalog fields for one app or many. Fields referenced by `query` or `sort` come back automatically; pass `--extra-fields` for more. Use `["match","product_id",<id>]` for a single app, or combine filters for population queries (e.g. iOS apps using Firebase with $1M+ US revenue). The 120+ fields span ranks, ratings, download and revenue estimates, SDKs, demographics, and more; query grammar and field list in [`docs get catalog_playbook`](#command-docs-get). |
104
-
| <ahref="#command-explorer-aggregate"><code>af explorer aggregate</code></a> | Aggregate across the 3M-app catalog: counts, averages, min/max, and histograms over any set of matching apps. Uses the same bespoke JSON query grammar as [`explorer query`](#command-explorer-query); returns aggregates, not app records. For market sizing, benchmarking, and segment analysis. |
105
-
| <ahref="#command-explorer-fields"><code>af explorer fields</code></a> | List the catalog fields and the current user's access level for each. Same field set [`explorer query`](#command-explorer-query) and [`explorer aggregate`](#command-explorer-aggregate) accept. Pass `--q` to search the catalog by keyword. |
103
+
| <ahref="#command-explorer-list-products"><code>af explorer list‑products</code></a> | Read catalog fields for one app or many. Fields referenced by `query` or `sort` come back automatically; pass `--extra-fields` for more. Use `["match","product_id",<id>]` for a single app, or combine filters for population queries (e.g. iOS apps using Firebase with $1M+ US revenue). The 120+ fields span ranks, ratings, download and revenue estimates, SDKs, demographics, and more; query grammar and field list in [`docs get catalog_playbook`](#command-docs-get). |
104
+
| <ahref="#command-explorer-aggregate-products"><code>af explorer aggregate‑products</code></a> | Aggregate across the full catalog of millions of products across Apple, Google Play, Amazon, and other major stores: counts, averages, min/max, and histograms over any set of matching products. Uses the same query grammar as [`explorer list-products`](#command-explorer-list-products); returns aggregates, not product records. For market sizing, benchmarking, and segment analysis. |
105
+
| <ahref="#command-explorer-describe-fields"><code>af explorer describe‑fields</code></a> | List the catalog fields and the current user's access level for each. Same field set [`explorer list-products`](#command-explorer-list-products) and [`explorer aggregate-products`](#command-explorer-aggregate-products) accept. Pass `--q` to search the catalog by keyword. |
106
106
107
107
### Metrics
108
108
@@ -142,25 +142,14 @@ Organic keyword visibility and tracking.
142
142
| ------- | ----------- |
143
143
| <ahref="#command-keywords-list"><code>af keywords list</code></a> | List tracked keywords with their opaque IDs. |
144
144
| <ahref="#command-keywords-rankings"><code>af keywords rankings</code></a> | Check the organic keywords one or more apps rank for, with position, popularity, and competitiveness. |
145
-
| <ahref="#command-keywords-results"><code>af keywords results</code></a> | List the apps ranking for a specific keyword in organic search, plus the keyword's own popularity and competitiveness scores. |
146
-
| <ahref="#command-keywords-related"><code>af keywords related</code></a> | Find keywords related to a seed term for ASO research. Useful for finding alternatives with a similar audience that are more popular or less competitive. |
147
-
148
-
### Apple Ads
149
-
150
-
Apple Search Ads intelligence.
151
-
152
-
| Command | Description |
153
-
| ------- | ----------- |
154
-
| <ahref="#command-apple-ads-keywords"><code>af apple‑ads keywords</code></a> | List the paid keywords one or more apps run ads on, with impression share and organic rank. |
155
-
| <ahref="#command-apple-ads-advertisers"><code>af apple‑ads advertisers</code></a> | List the apps advertising on a specific keyword, with each advertiser's impression share, organic rank, and how long they've been bidding. |
156
145
157
146
### Sdks
158
147
159
-
Look up canonical SDK IDs by name across the SDKs Appfigures tracks. The IDs are the values [`explorer query`](#command-explorer-query) accepts as SDK filters.
148
+
Look up the SDKs we track.
160
149
161
150
| Command | Description |
162
151
| ------- | ----------- |
163
-
| <ahref="#command-sdks-list"><code>af sdks list</code></a> | List every known SDK with its id. Use the id to filter apps by SDK in [`explorer query`](#command-explorer-query). |
152
+
| <ahref="#command-sdks-list"><code>af sdks list</code></a> | List every known SDK with its id, or search to find a specific one. |
164
153
165
154
### Docs
166
155
@@ -224,7 +213,7 @@ Every command with its full argument and flag list. For the one-line overview, s
224
213
225
214
`af apps search <query> [flags]`
226
215
227
-
Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings; pass `--all-stores` to include other storefronts. To filter apps by estimate values (e.g. apps with >100k downloads last month) use [`explorer query`](#command-explorer-query). For estimates broken down by time, country, or storefront, use [`metrics query`](#command-metrics-query) with datasets estimates.sales or estimates.revenue.
216
+
Find apps by name or publisher. Returns one row per unified app. Default returns Apple and Google listings; pass `--all-stores` to include other storefronts. To filter apps by estimate values (e.g. apps with >100k downloads last month) use [`explorer list-products`](#command-explorer-list-products). For estimates broken down by time, country, or storefront, use [`metrics query`](#command-metrics-query) with datasets estimates.sales or estimates.revenue.
228
217
229
218
**Options**
230
219
@@ -270,17 +259,17 @@ Get an app's record: basic metadata (name, developer, etc) and, if the user trac
270
259
271
260
---
272
261
273
-
<aid="explorer-query"></a>
274
-
<aid="command-explorer-query"></a>
275
-
### af explorer query
262
+
<aid="explorer-list-products"></a>
263
+
<aid="command-explorer-list-products"></a>
264
+
### af explorer list-products
276
265
277
-
`af explorer query [query] [flags]`
266
+
`af explorer list-products [flags]`
278
267
279
268
Read catalog fields for one app or many. Fields referenced by `query` or `sort` come back automatically; pass `--extra-fields` for more. Use `["match","product_id",<id>]` for a single app, or combine filters for population queries (e.g. iOS apps using Firebase with $1M+ US revenue). The 120+ fields span ranks, ratings, download and revenue estimates, SDKs, demographics, and more; query grammar and field list in [`docs get catalog_playbook`](#command-docs-get).
280
269
281
270
**Options**
282
271
283
-
-`[query]` array. Explorer query in JSON array format to select matching catalog Products. Missing values and `[]` match every Product across every storefront. The full field list and query syntax are documented in [`docs get catalog_playbook`](#command-docs-get).
272
+
-`--query` array. Explorer query in JSON array format to select matching catalog Products. Missing values and `[]` match every Product across every storefront. The full field list and query syntax are documented in [`docs get catalog_playbook`](#command-docs-get).
284
273
-`--extra-fields` string[]. Additional fields to include. The full field list is documented in [`docs get catalog_playbook`](#command-docs-get).
285
274
-`--sort` string. Explorer field name. The full field list is documented in [`docs get catalog_playbook`](#command-docs-get).
@@ -290,36 +279,37 @@ Read catalog fields for one app or many. Fields referenced by `query` or `sort`
290
279
291
280
---
292
281
293
-
<aid="explorer-aggregate"></a>
294
-
<aid="command-explorer-aggregate"></a>
295
-
### af explorer aggregate
282
+
<aid="explorer-aggregate-products"></a>
283
+
<aid="command-explorer-aggregate-products"></a>
284
+
### af explorer aggregate-products
296
285
297
-
`af explorer aggregate <fields> [flags]`
286
+
`af explorer aggregate-products <fields> [flags]`
298
287
299
-
Aggregate across the 3M-app catalog: counts, averages, min/max, and histograms over any set of matching apps. Uses the same bespoke JSON query grammar as [`explorer query`](#command-explorer-query); returns aggregates, not app records. For market sizing, benchmarking, and segment analysis.
288
+
Aggregate across the full catalog of millions of products across Apple, Google Play, Amazon, and other major stores: counts, averages, min/max, and histograms over any set of matching products. Uses the same query grammar as [`explorer list-products`](#command-explorer-list-products); returns aggregates, not product records. For market sizing, benchmarking, and segment analysis.
300
289
301
290
**Options**
302
291
303
292
-`--query` array. Explorer query in JSON array format to select matching catalog Products. Missing values and `[]` match every Product across every storefront. The full field list and query syntax are documented in [`docs get catalog_playbook`](#command-docs-get).
304
293
-`<fields>` required string[]. Field+aggregation pairs (e.g. `all_rating/stats`, `storefronts/terms`). Aggregations: `stats`, `terms`, `histogram`, `date_histogram`, `cardinality`. The full field list is documented in [`docs get catalog_playbook`](#command-docs-get).
305
294
-`--allow-unscoped-nested` boolean, default `false`. Escape hatch for intentionally broad queries. Bypasses the default block on unscoped nested predicates that usually inflate results.
306
295
-`--terms-count` integer, default `20`. Maximum buckets returned for each `terms` aggregation. Other aggregation types ignore it.
296
+
-`--date-histogram-interval` string. Bucket granularity for each `date_histogram` aggregation. Other aggregation types ignore it.
307
297
308
298
---
309
299
310
-
<aid="explorer-fields"></a>
311
-
<aid="command-explorer-fields"></a>
312
-
### af explorer fields
300
+
<aid="explorer-describe-fields"></a>
301
+
<aid="command-explorer-describe-fields"></a>
302
+
### af explorer describe-fields
313
303
314
-
`af explorer fields [flags]`
304
+
`af explorer describe-fields [flags]`
315
305
316
-
List the catalog fields and the current user's access level for each. Same field set [`explorer query`](#command-explorer-query) and [`explorer aggregate`](#command-explorer-aggregate) accept. Pass `--q` to search the catalog by keyword.
306
+
List the catalog fields and the current user's access level for each. Same field set [`explorer list-products`](#command-explorer-list-products) and [`explorer aggregate-products`](#command-explorer-aggregate-products) accept. Pass `--q` to search the catalog by keyword.
317
307
318
308
**Options**
319
309
320
310
-`--count` integer, default `50`. Number of results to return
321
311
-`--page` integer, default `1`. Page number.
322
-
-`--q` string. Fuzzy string match on`path`, `title`, `description`, `type`.
@@ -403,7 +393,7 @@ List every store category with its ID. Numeric category IDs required by [`store
403
393
404
394
-`--count` integer, default `50`. Number of results to return
405
395
-`--page` integer, default `1`. Page number.
406
-
-`--q` string. Fuzzy string match on`name`.
396
+
-`--q` string. Filter by`name`.
407
397
-`--sort-by` string. Sort order. Default: relevance when `q` is set, otherwise list order.
408
398
-`--id` integer[]. Only return these category IDs.
409
399
-`--parent-id` integer. Only include subcategories of this parent category (drill-down by id).
@@ -499,6 +489,8 @@ Aggregate review counts for one or more apps, bucketed by dimension. Returns one
499
489
-`--filter-apps-by-type` string[]. Narrow the account's tracked apps to products of these types.
500
490
-`--start` string. Start date (YYYY-MM-DD)
501
491
-`--end` string. End date (YYYY-MM-DD, defaults to today)
492
+
-`--by` string[]. Limit the response to these dimensions; omit to return all.
493
+
-`--top` integer, default `20`. Maximum values returned per dimension; the rest are summed under `__other__`.
502
494
503
495
---
504
496
@@ -530,7 +522,7 @@ List tracked keywords with their opaque IDs.
530
522
531
523
-`--count` integer, default `10`. Number of results to return
532
524
-`--page` integer, default `1`. Page number.
533
-
-`--q` string. Fuzzy string match on`keyword_term`.
525
+
-`--q` string. Filter by`keyword_term`.
534
526
-`--sort-by` string. Sort order. Default: relevance when `q` is set, otherwise list order.
535
527
-`--include-relationships` boolean, default `false`. Include per-(product, country) tracking detail and sync state on each row. Off by default; adds a nested block per tracked (product, country) pair.
536
528
@@ -554,95 +546,19 @@ Check the organic keywords one or more apps rank for, with position, popularity,
554
546
555
547
---
556
548
557
-
<aid="keywords-results"></a>
558
-
<aid="command-keywords-results"></a>
559
-
### af keywords results
560
-
561
-
`af keywords results <keyword-name> [flags]`
562
-
563
-
List the apps ranking for a specific keyword in organic search, plus the keyword's own popularity and competitiveness scores.
564
-
565
-
**Options**
566
-
567
-
-`<keyword-name>` required string. Keyword to look up.
568
-
-`--country` required string. ISO country code (e.g. US, JP, GB)
569
-
-`--storefront` required string. App store platform (e.g. apple:ios, google_play, amazon_appstore, steam, windows10, apple:mac, apple:tv, apple:imessage, or another supported storefront).
570
-
-`--device-type` string. Device type
571
-
-`--count` integer, default `10`. Number of results to return
572
-
-`--page` integer, default `1`. Page number.
573
-
574
-
---
575
-
576
-
<aid="keywords-related"></a>
577
-
<aid="command-keywords-related"></a>
578
-
### af keywords related
579
-
580
-
`af keywords related <keyword-name> [flags]`
581
-
582
-
Find keywords related to a seed term for ASO research. Useful for finding alternatives with a similar audience that are more popular or less competitive.
583
-
584
-
**Options**
585
-
586
-
-`<keyword-name>` required string. Seed keyword to find related terms for.
587
-
-`--country` string. ISO country code (e.g. US, JP, GB)
588
-
-`--storefront` string. App store platform (e.g. apple:ios, google_play, amazon_appstore, steam, windows10, apple:mac, apple:tv, apple:imessage, or another supported storefront).
589
-
-`--device-type` string. Device type
590
-
-`--count` integer, default `10`. Number of results to return
591
-
-`--page` integer, default `1`. Page number.
592
-
593
-
---
594
-
595
-
<aid="apple-ads-keywords"></a>
596
-
<aid="command-apple-ads-keywords"></a>
597
-
### af apple-ads keywords
598
-
599
-
`af apple-ads keywords <product-ids> [flags]`
600
-
601
-
List the paid keywords one or more apps run ads on, with impression share and organic rank.
602
-
603
-
**Options**
604
-
605
-
-`<product-ids>` required integer[]. Product identifiers (numeric, one storefront each).
606
-
-`--days` integer, default `180`. Lookback period in days. Common values: 7, 14, 30, 90, 180, 365.
607
-
-`--country` string. ISO country code (e.g. US, JP, GB)
608
-
-`--device-type` string. Device type
609
-
-`--count` integer, default `10`. Number of results to return (min 10).
610
-
-`--page` integer, default `1`. Page number.
611
-
612
-
---
613
-
614
-
<aid="apple-ads-advertisers"></a>
615
-
<aid="command-apple-ads-advertisers"></a>
616
-
### af apple-ads advertisers
617
-
618
-
`af apple-ads advertisers <keyword-name> [flags]`
619
-
620
-
List the apps advertising on a specific keyword, with each advertiser's impression share, organic rank, and how long they've been bidding.
621
-
622
-
**Options**
623
-
624
-
-`<keyword-name>` required string. Keyword to look up advertisers for
625
-
-`--days` integer, default `180`. Lookback period in days. Common values: 7, 14, 30, 90, 180, 365.
626
-
-`--country` string. ISO country code (e.g. US, JP, GB)
627
-
-`--device-type` string. Device type
628
-
-`--count` integer, default `10`. Number of results to return
629
-
-`--page` integer, default `1`. Page number.
630
-
631
-
---
632
-
633
549
<aid="sdks-list"></a>
634
550
<aid="command-sdks-list"></a>
635
551
### af sdks list
636
552
637
553
`af sdks list [flags]`
638
554
639
-
List every known SDK with its id. Use the id to filter apps by SDK in [`explorer query`](#command-explorer-query).
555
+
List every known SDK with its id, or search to find a specific one.
640
556
641
557
**Options**
642
558
643
559
-`--count` integer, default `50`. Number of results to return
644
560
-`--page` integer, default `1`. Page number.
645
-
-`--q` string. Fuzzy string match on`name`, `description`, `tags`.
0 commit comments