List subscriptions

Lists dashboard, report, commitment, alert, and budget subscriptions visible to the caller. Items are ordered by id ascending. Nested subscriptions are ordered by type ascending. maxResults defaults to 50. An omitted value, 0, or a value above 500 is treated as 50. A non-integer maxResults is 400. Pass the response pageToken to request the next page. That field is absent when there are no more pages. A pageToken that matches no id is 400. rowCount is the total number of subscriptions visible to the caller. That value is the same on every page.
One subscription record is one item. Its dashboard, report, and commitment subscriptions are nested entries that share recipients. An alert is one item. A budget is one item. An alert or a budget never shares an item with a scheduled subscription. Draft budgets are omitted. An alert is included only when the tenant has the Governance Alerts entitlement and the caller can view that alert. When the entitlement is missing or cannot be confirmed, the list contains no alerts. An alert with no recipients is still included.
One id namespace is shared by a scheduled subscription, an alert, and a budget. Create accepts only dashboard-subscription, report-subscription, and commitment-manager. Those scheduled types are the resource: create, recipient replace, subscription-set replace, and delete. GET returns alerts and budgets so a caller can see who receives them. Create, delete, and full management of those resources, including recipients, stay on PATCH /analytics/v1/alerts/{id} and PATCH /analytics/v1/budgets/{id}. PATCH on this API may replace those same recipient lists. DELETE of an alert or a budget returns 409 customers.entry_is_resource.
Manage Settings users can view every subscription. A scheduled subscription is also visible to its creator when the caller has the permission for that type, to an owner, editor, or viewer of its source, and to one of its email recipients. Users Manager alone grants no access. A service-account token is evaluated from its own permissions and does not inherit the permissions of the subscription creator. A caller who can see only some nested subscriptions still receives that record; subscriptions omits the entries they cannot see.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
int64
Defaults to 50

The maximum number of results to return in a single page. Use the page tokens to iterate through the entire collection.

string

Page token, returned by a previous call, to request the next page of results

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json