Site breakdown
get_site_breakdownOne of a site's panes in full, as its view on the dashboard has it: the values of one dimension over a range, most first, each with its count, its share of the pane and the filter that narrows to it. The answer's caveats are the rules that apply to its figures, such as visitors being visitor-days or today being partial: read them before reporting any figure, and pass on those that change what it means. Name the site, range and filters as for get_site_summary, which refuses the same things. dimension is the pane. search keeps the values containing it, ignoring case: google finds Google News beside Google. limit, 1 to 50 (10 by default), and offset page through them: distinct is how many there are, following how many come after, and next_offset where the next page starts, null at the end. metric ranks a pane of pageviews, visits and visitors by one. By default a channel, source, referrer or campaign (utm_) pane is ranked by visits, and so are entry and exit, the rest by pageviews; ranked_by names the count, and dashboard_counts the linked view's where it differs. compare gives each row previous and change, against the period get_site_summary compares with, and is refused for all time. trend gives each row its counts by day, week or month; limit times their number must be at most 1000. Shares are fractions of 1; change, bounce_rate and average_percent whole percentages. A pane the filters rule out is answered with available: false, why and what to try.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | No | With from: the last day, as YYYY-MM-DD, not after today. | |
| data | No | With dimension event_data, and only then: the name the event's data was sent under, such as plan. Leave it out, with no search, limit, offset, metric, compare or trend, for data_names: the names sent with the event in the range, most carried first. A name sent nowhere in the range, as one guessed wrong is, gives them too. | |
| days | No | The last this many days, ending today unless ending says yesterday. | |
| from | No | With to: the first day, as YYYY-MM-DD. | |
| limit | No | How many values, 10 by default. | |
| range | No | A preset, as get_site_summary's range says what each covers. | |
| trend | No | Give each row's counts by day, week or month over the range. | |
| domain | Yes | A domain from list_sites, or any public site's. | |
| ending | No | With days: the last day, today by default. | |
| folder | No | With dimension folder: the folder to open, starting and ending with /, such as /blog/; / by default. | |
| metric | No | The count to rank by: visits by default for channel, source, referrer and the utm_ dimensions, and for entry and exit; pageviews for the rest. Refused for a pane with one count, from outbound to event_data, and under a goal filter, where every pane counts conversions. | |
| offset | No | How many values to pass over first, 0 by default. | |
| search | No | Only the values containing this, ignoring case: of a country, its name or its code. | |
| compare | No | Give each row its count over the period before, and its change. | |
| filters | No | Each narrows every figure to what has exactly that value, case and all, so google is not Google; all must hold. | |
| property | No | With dimension property, and only then: the custom property, such as plan. Leave it out, with no search, limit, offset, metric, compare or trend, for properties: the site's custom properties counted in the range, most carried first, each by the name this takes. A property counted nowhere in the range, as a name guessed wrong is, gives them too. | |
| dimension | Yes | The pane: a dimension filters take, whose values are as get_site_summary's filters say, or one of these. folder: pages folder by folder, from / or the folder named by folder; a row with folder true is a folder, opened by asking again with folder set to its value. outbound: links followed to other sites, in clicks. download: files downloaded, by path. searches: what visitors searched the site for, by term and page, with no_results, its searches that found nothing. error: page loads answered with an error, by path, each with its status. time_on_page and scroll_depth: pages by their readings, with the average, and for depth read_to_end and scrolled. slowest_lcp and slowest_inp: pages by how many of their loads were poor, beside the loads measured, with poor_share. From outbound to slowest_inp, these are counted by page, not by visit, so a goal, entry or exit filter rules them out. property: the values of the custom property named by property, or without property, the custom properties themselves. event_data: under a filter by an event goal, and only then, the values the event's data was sent with under the name data gives, such as pro for plan in tally('Signup', { plan: 'pro' }), in events; without data, the names its data was sent under. |