Retrieve a subscription

Returns one dashboard, report, commitment, alert, or budget subscription. The body is the same object as a list item. schedule is omitted on an alert or a budget.
Create does not accept alert or budget. GET returns them. PATCH may replace their recipient lists, which writes the same lists as PATCH /analytics/v1/alerts/{id} and PATCH /analytics/v1/budgets/{id}. Create, delete, and full management stay on those APIs. DELETE of an alert or a budget returns 409 customers.entry_is_resource.
Manage Settings users can view the 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. Keys the caller cannot see are omitted from subscriptions. A missing, foreign-tenant, or non-visible subscription returns 404 without revealing whether it exists.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Subscription id returned by list or create. Ids are independent ids of a scheduled subscription, an alert, or a budget. The server looks up a scheduled subscription, then an alert, then a budget. An id found in more than one of those collections is 409 customers.subscription_id_ambiguous. That is an invariant breach. There is no second identifier to send, and a client cannot disambiguate it. Auto-generated ids do not collide.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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