Get statistics for an OAuth profile

Hybrid Data Pipeline API reference : Management API : OAuth API for Google Analytics connectivity : OAuth profiles API : Get statistics for an OAuth profile

Try Now

Purpose

Retrieves statistics for an OAuth profile. Statistics include the number of data sources that use the OAuth profile and information on the data sources themselves.

Note: An administrator can execute this operation on behalf of a user by appending the user query parameter to the request and specifying a user name. See also Managing resources on behalf of users.

URL

https://<myserver>:<port>/api/mgmt/oauthprofiles/{id}/stats

Method

GET

URL parameters

<myserver> is the hostname or IP address of the machine hosting the Hybrid Data Pipeline server for a standalone installation, or the machine hosting the load balancer for a load balancer installation. For a standalone installation, <port> is the port number specified as the Server Access Port during installation. For a load balancer installation, <port> must be either 80 for http or 443 for https. Whenever port 80 or 443 are used, it is not necessary to include the port number in the URL.

The URL parameter {id} is required.

Parameter	Description	Valid Values
{id}	The ID of the OAuth profile.	The automatically generated OAuth profile ID.

Response definition

The response takes the following format.

{
"dataSourcesLinked": integer,
"dataStoreId": data_store_id,
"dataSources": [
{
"id": data_source_id,
"name": "data_source_name",
"description":"data_source_description"
},
...
]
}

Parameter	Description	Valid values
"dataSourcesLinked"	The number of data sources which the OAuth profile links to.	A non-negative integer.
"dataStoreId"	The ID of the data store for which the OAuth application object is being created.	The only data store which Hybrid Data Pipeline currently supports access to is Google Analytics. Therefore, the only valid value is the Google Analytics data store ID: 54.
"dataSources"	A list of the data sources linked to the OAuth profile.	A comma separated list of data source objects that contains the id, name, and description for each linked data source.

Sample Server Response

Status code: 200
Successful response

{
"dataSourcesLinked": 2,
"dataStoreId": 54,
"dataSources": [
{
"id": "503",
"name": "GAtest",
"description":"test"
},
{
"id": "611",
"name": "GAprod",
"description":"production"
}
]
}

Sample server failure response

{
"error": {
"code": "222207710",
"message": {
"lang": "en-US",
"value": "Invalid OAuthProfileId: 30"
}
}

Authentication

Basic Authentication using Login ID and Password.

Authorization

The user must have the MgmtAPI (11) and ViewDataSource (2) permissions.