Docs
Cerca nella documentazione...⌘K

UTM parameters

API + MCPSolo Enterprise
POST/v3/site-explorer/traffic-utm-params

Requires the Traffic Analytics Enterprise add-on.

Corpo della richiesta

selectarray<string>Required

A list of fields to return.

Example:["field_a","field_b"]
targetstring (url)Required

The target of the search: a domain or a URL.

modestring

The scope of the target.

Valori consentiti:exactprefixdomainsubdomains
Default:subdomains
protocolstring

The protocol of your target.

Valori consentiti:bothhttphttps
Default:both
date_fromstring (date)

The first day of the period in YYYY-MM-DD format (UTC). The period defaults to the last 30 days with estimates and is clamped to the days with estimates. Must not be after date_to.

date_tostring (date)

The last day of the period in YYYY-MM-DD format (UTC).

whereobject

where filters the visits by the report's dimensions, which changes the totals and the shares, and the rows by their metrics, which does not. On the dimensions, isubstring ignores the case and eq, prefix and suffix match it, but on search_term, which ignores it.

searchstring

Only the rows whose label contains this text, case-insensitive. It narrows the rows and not the totals, so the shares stay those of the whole report.

order_bystring

A field to order the results by, with optional direction. Format: field_name:asc or field_name:desc (default desc).

Example:field_a:asc
limitinteger

The number of rows to return (1 to 100).

Min:1Max:100
Default:100
offsetinteger

The number of rows to skip.

Min:0
Default:0
utm_paramstringRequired

The UTM parameter the rows break the visits down by.

Valori consentiti:utm_sourceutm_mediumutm_campaignutm_termutm_content
outputstring

The output format.

Valori consentiti:jsonphp

Risposte

utm_paramsarray<object>
bounce_ratenumber (float) or null

The estimated share of the visits that viewed a single page, as a percent.

pages_per_visitnumber (float) or null

The estimated number of page views per visit.

pageviewsinteger

The estimated number of page views.

sharenumber (float)

The share of the report's visits, as a percent.

utm_paramstring

The value of the UTM parameter utm_param names; an empty string for the visits whose landing page has none.

visit_durationinteger or null

The estimated average visit duration, in seconds. Visits of a single page, whose length is unknown, are left out.

visitorsinteger

The estimated number of unique visitors, counted per day: a person who visits on two days counts twice.

visitsinteger

The estimated number of visits in the period. Visits that enter from the target's own website are not counted.