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.

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 non-load balancer deployment, or the machine hosting the load balancer for a load balancer deployment. For a non-load balancer deployment, <port> is the port number specified as the Server Access Port during deployment. For a load balancer deployment, <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 Hybrid Data Pipeline currently supports access to the following data stores:
  • Google Analytics (ID: 54)
  • Google BigQuery (ID: 62)
  • Salesforce (ID: 1)
  • Autonomous REST Connector (ID: 63)
"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": "DStest",
        "description":"test"
      },
      {
        "id": "611",
        "name": "DSprod",
        "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.