VOOZH about

URL: https://docs.similarweb.com/api-v5/api-reference/website-analysis-api/website-content/website-folders

⇱ Similarweb API V5 Documentation

Getting Started

Sections

Theme switcher

Website Folders

Returns a list of leading folders for a domain and share per folder

Output Fields:

  • folder: Folder path (top-level directory)
  • share: The estimated traffic share percentage for this folder
  • change: Percentage point change of folder traffic share compared to the previous month

This endpoint uses data credits. Read the following guide to estimate the credit costs.

Constraints:

  • web_source support only 'total'
  • granularity supports only monthly granularity, or daily granularity for the last 28 days only

Header Parameters

api-keystring

Query Parameters

domainstring Required

Website domain without 'www.' (e.g., 'example.com')

start_datestring

Start date in 'YYYY-MM' or 'YYYY-MM-DD' format

end_datestring

End date in 'YYYY-MM' or 'YYYY-MM-DD' format

granularitystring

Time granularity

Enum values:
dailyweeklymonthly
web_sourcestring

Specifies the web source device type

Enum values:
desktopmobile_webtotal
countrystring

Two-letter country code (e.g., 'us', 'gb', 'ww')

main_domain_onlyboolean

'true' to include only the main domain, 'false' to include subdomains. Default is 'false'

formatstring

Format in which the reply should be returned.

Enum values:
jsonxml
limitinteger

Number of items per page for pagination, default is 100

offsetinteger

Page number for pagination, starting from 1

ascboolean

Sort order direction, 'true' for ascending, 'false' for descending. Default is 'false'

Nullable:
True
sortstring

Sort order for the results, applied on the properties of the returned record

Response

200
Object

Success

Response Attributes

metaobject
dataarray
Nullable:
True
Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?