Research

See Using commands for how flags, JSON input, paging and confirmations work. Run adside research --help to see what your installed version has.

research discover

Discover competitors for the workspace’s company.

adside research discover

research feed

Query and filter the workspace’s cross-competitor ad feed.

adside research feed [flags]

Flag	Value	What it does
`--channels`	`'<json>'`
`--tracked-company-ids`	`'<json>'`
`--collection-id`	`<id>`
`--classification`	`COMPETITOR\|INSPIRATION\|SELF`
`--classifications`	`'<json>'`
`--landing-pages`	`'<json>'`
`--languages`	`'<json>'`
`--ai-tags`	`'<json>'`
`--format-types`	`'<json>'`
`--days-active`	`under7\|over7`
`--statuses`	`'<json>'`
`--ad-lengths`	`'<json>'`
`--sort`	`newest\|longevity\|impressions=newest`
`--cursor`	`<next>`	The next page, from the previous output.
`--limit`	`<1-100>=50`

research ad-library

research ad-library search

Search cached brand ads or explicitly request a paid scrape.

adside research ad-library search [flags]

Flag	Value	What it does
`--run-id`	`<id>`	Check on a scrape this tool started earlier. When set, every other field is ignored.
`--brand-name`	`<brand-name>`	The brand or company name. Required unless `runId` is set.
`--channel`	`META\|GOOGLE\|LINKEDIN`	Which ad library to search. Required unless `runId` is set.
`--domain`	`<domain>`	The brand’s website domain, for example `nike.com`. Required for GOOGLE.
`--meta-page-id`	`<id>`	The brand’s numeric Facebook page id. Required for META.
`--start-scrape`	`true\|false=false`	Set to true to start a paid scrape when the brand’s ads are not already collected. Leave false to only read what is cached.
`--limit`	`<1-25>=10`	How many ads to return (max 25).

research ads

research ads analysis

Read an existing creative analysis for a tracked company’s ad.

adside research ads analysis --tracked-company-id <id> --source META|GOOGLE|LINKEDIN --ad-archive-id <id>

research ads brands

Search public brands by name.

adside research ads brands --q <q>

research ads company

Read all cached ad sources, insights and pending runs for a tracked company.

adside research ads company --tracked-company-id <id>

research ads fetch

Read cached public ads or start an asynchronous brand scrape.

adside research ads fetch --channel META|GOOGLE|LINKEDIN [flags]

Flag	Value
`--channel` (required)	`META\|GOOGLE\|LINKEDIN`
`--limit`	`<1-500>`
`--force-refresh`	`true\|false`
`--tracked-company-id`	`<id>`
`--adlibrary-url`	`<adlibrary-url>`
`--search-term`	`<search-term>`
`--domain`	`<domain>`
`--company-name`	`<company-name>`

research ads run

Read the status and results of a public ad-library scrape.

adside research ads run --run-id <id>

research ads suggestions

Find Meta Ad Library pages for a brand.

adside research ads suggestions --q <q> [flags]

Flag	Value
`--q` (required)	`<q>`
`--domain`	`<domain>`

research ads transcript

Read an existing transcript for a tracked company’s video ad.

adside research ads transcript --source META|GOOGLE|LINKEDIN --ad-archive-id <id>

research collections

research collections add

Add a tracked company to a collection.

adside research collections add --collection-id <id> --tracked-company-id <id>

research collections create

Create a company collection.

adside research collections create --name <name> [flags]

Flag	Value
`--name` (required)	`<name>`
`--description`	`<description>`
`--icon`	`<icon>`
`--color`	`<color>`

research collections delete

Delete a custom company collection.

adside research collections delete --collection-id <id>

research collections get

Read a company collection and its members.

adside research collections get --collection-id <id>

research collections list

List company collections.

adside research collections list

research collections remove

Remove a company from a collection.

adside research collections remove --collection-id <id> --tracked-company-id <id>

research collections update

Update a company collection.

adside research collections update --collection-id <id> [flags]

Flag	Value
`--collection-id` (required)	`<id>`
`--name`	`<name>`
`--description`	`<description>`
`--icon`	`<icon>`
`--color`	`<color>`

research companies

research companies ads get

Read a tracked company’s ad for its detail view.

adside research companies ads get --company-id <id> --source META|GOOGLE|LINKEDIN --ad-archive-id <id>

research companies delete

Archive a tracked company, or permanently remove it.

adside research companies delete --company-id <id> [flags]

Flag	Value
`--company-id` (required)	`<id>`
`--hard`	`true\|false=false`

research companies get

Read a tracked company.

adside research companies get --company-id <id>

research companies list

List tracked companies and their current extraction state.

adside research companies list [flags]

Flag	Value
`--status`	`active\|paused\|archived`
`--collection-id`	`<id>`
`--classification`	`COMPETITOR\|INSPIRATION\|SELF`

research companies refresh-ads

Refresh tracked-company ads, with explicit force for an already populated library.

adside research companies refresh-ads --company-id <id> [flags]

Flag	Value
`--company-id` (required)	`<id>`
`--force-refresh`	`true\|false=false`

research companies refresh-profile

Refresh a competitor profile subject to the shared cooldown.

adside research companies refresh-profile --company-id <id>

research companies track

Track or reactivate a company and request its research.

adside research companies track --website-url <url> [flags]

Flag	Value
`--website-url` (required)	`<url>`
`--collection-ids`	`'<json>'`
`--nickname`	`<nickname>`
`--notes`	`<notes>`
`--priority`	`<1-5>`
`--classification`	`COMPETITOR\|INSPIRATION\|SELF`

research companies update

Update a tracked company’s workspace metadata.

adside research companies update --company-id <id> [flags]

Flag	Value
`--company-id` (required)	`<id>`
`--nickname`	`<nickname>`
`--notes`	`<notes>`
`--priority`	`<1-5>`
`--classification`	`COMPETITOR\|INSPIRATION\|SELF`
`--status`	`active\|paused\|archived`

research inspiration

research inspiration get

Read one inspiration item in this workspace’s feed.

adside research inspiration get --item-id <id>

research inspiration list

Read the workspace inspiration feed.

adside research inspiration list [flags]

Flag	Value	What it does
`--page`	`<min 1>=1`	The next page, from the previous output.
`--page-size`	`<1-100>=24`

research inspiration refresh

Refresh the workspace inspiration feed.

adside research inspiration refresh

research inspiration run

Read inspiration refresh status.

adside research inspiration run --run-id <id>

CLI

Command reference

Research

research

research discover

research feed

research ad-library

research ad-library search

research ads

research ads analysis

research ads brands

research ads company

research ads fetch

research ads run

research ads suggestions

research ads transcript

research collections

research collections add

research collections create

research collections delete

research collections get

research collections list

research collections remove

research collections update

research companies

research companies ads get

research companies delete

research companies get

research companies list

research companies refresh-ads

research companies refresh-profile

research companies track

research companies update

research inspiration

research inspiration get

research inspiration list

research inspiration refresh

research inspiration run

​research

​research discover

​research feed

​research ad-library

​research ad-library search

​research ads

​research ads analysis

​research ads brands

​research ads company

​research ads fetch

​research ads run

​research ads suggestions

​research ads transcript

​research collections

​research collections add

​research collections create

​research collections delete

​research collections get

​research collections list

​research collections remove

​research collections update

​research companies

​research companies ads get

​research companies delete

​research companies get

​research companies list

​research companies refresh-ads

​research companies refresh-profile

​research companies track

​research companies update

​research inspiration

​research inspiration get

​research inspiration list

​research inspiration refresh

​research inspiration run

research

research discover

research feed

research ad-library

research ad-library search

research ads

research ads analysis

research ads brands

research ads company

research ads fetch

research ads run

research ads suggestions

research ads transcript

research collections

research collections add

research collections create

research collections delete

research collections get

research collections list

research collections remove

research collections update

research companies

research companies ads get

research companies delete

research companies get

research companies list

research companies refresh-ads

research companies refresh-profile

research companies track

research companies update

research inspiration

research inspiration get

research inspiration list

research inspiration refresh

research inspiration run