{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"entity": {
"type": "string",
"description": "The Data Access Report supports requesting at the property level or account level. If requested at the account level, Data Access Reports include all access for all properties under that account. To request at the property level, entity should be for example 'properties/123' if \"123\" is your GA4 property ID. To request at the account level, entity should be for example 'accounts/1234' if \"1234\" is your GA4 Account ID."
},
"dateRanges": {
"type": "array",
"items": {
"type": "object",
"properties": {
"endDate": {
"type": "string",
"description": "The inclusive end date for the query in the format `YYYY-MM-DD`. Cannot be before `startDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone."
},
"startDate": {
"type": "string",
"description": "The inclusive start date for the query in the format `YYYY-MM-DD`. Cannot be after `endDate`. The format `NdaysAgo`, `yesterday`, or `today` is also accepted, and in that case, the date is inferred based on the current time in the request's time zone."
}
}
},
"description": "Date ranges of access records to read. If multiple date ranges are requested, each response row will contain a zero based date range index. If two date ranges overlap, the access records for the overlapping days is included in the response rows for both date ranges. Requests are allowed up to 2 date ranges."
},
"dimensionFilter": {
"type": "object",
"description": "Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.",
"properties": {
"accessFilter": {
"type": "object",
"description": "An expression to filter dimension or metric values."
},
"andGroup": {
"type": "object",
"description": "A list of filter expressions."
},
"notExpression": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression"
},
"orGroup": {
"type": "object",
"description": "A list of filter expressions."
}
}
},
"dimensions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"dimensionName": {
"type": "string",
"description": "The API name of the dimension. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of dimensions supported in this API. Dimensions are referenced by name in `dimensionFilter` and `orderBys`."
}
}
},
"description": "The dimensions requested and displayed in the response. Requests are allowed up to 9 dimensions."
},
"limit": {
"type": "string",
"description": "The number of rows to return. If unspecified, 10,000 rows are returned. The API returns a maximum of 100,000 rows per request, no matter how many you ask for. `limit` must be positive. The API may return fewer rows than the requested `limit`, if there aren't as many remaining rows as the `limit`. For instance, there are fewer than 300 possible values for the dimension `country`, so when reporting on only `country`, you can't get more than 300 rows, even if you set `limit` to a higher value. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination)."
},
"metricFilter": {
"type": "object",
"description": "Expresses dimension or metric filters. The fields in the same expression need to be either all dimensions or all metrics.",
"properties": {
"accessFilter": {
"type": "object",
"description": "An expression to filter dimension or metric values."
},
"andGroup": {
"type": "object",
"description": "A list of filter expressions."
},
"notExpression": {
"type": "object",
"description": "Circular schema reference: #/components/schemas/GoogleAnalyticsAdminV1betaAccessFilterExpression"
},
"orGroup": {
"type": "object",
"description": "A list of filter expressions."
}
}
},
"metrics": {
"type": "array",
"items": {
"type": "object",
"properties": {
"metricName": {
"type": "string",
"description": "The API name of the metric. See [Data Access Schema](https://developers.google.com/analytics/devguides/config/admin/v1/access-api-schema) for the list of metrics supported in this API. Metrics are referenced by name in `metricFilter` & `orderBys`."
}
}
},
"description": "The metrics requested and displayed in the response. Requests are allowed up to 10 metrics."
},
"offset": {
"type": "string",
"description": "The row count of the start row. The first row is counted as row 0. If offset is unspecified, it is treated as 0. If offset is zero, then this method will return the first page of results with `limit` entries. To learn more about this pagination parameter, see [Pagination](https://developers.google.com/analytics/devguides/reporting/data/v1/basics#pagination)."
},
"orderBys": {
"type": "array",
"items": {
"type": "object",
"properties": {
"desc": {
"type": "boolean",
"description": "If true, sorts by descending order. If false or unspecified, sorts in ascending order."
},
"dimension": {
"type": "object",
"description": "Sorts by dimension values."
},
"metric": {
"type": "object",
"description": "Sorts by metric values."
}
}
},
"description": "Specifies how rows are ordered in the response."
},
"returnEntityQuota": {
"type": "boolean",
"description": "Toggles whether to return the current state of this Analytics Property's quota. Quota is returned in [AccessQuota](#AccessQuota). For account-level requests, this field must be false."
},
"timeZone": {
"type": "string",
"description": "This request's time zone if specified. If unspecified, the property's time zone is used. The request's time zone is used to interpret the start & end dates of the report. Formatted as strings from the IANA Time Zone database (https://www.iana.org/time-zones); for example \"America/New_York\" or \"Asia/Tokyo\"."
}
},
"required": [
"PCID",
"entity"
]
}
