Retrieving data from ACTIVE Net Insights

To retrieve data from ACTIVE Net insights, your system needs to:

1. Call the API using the HTTP GET method with the required request parameters.

2. Parse the JSON-formatted response.

This chapter includes the following sections:

• Preparing your request URL

• Request parameters

• Receiving API responses

Preparing your request URL

Note that if you have enabled enhanced-security ACTIVENet System APIs, to make API requests using both the API key and a digital signature, refer here.

To prepare the request URL for an API call, refer to the following template.

The request URL consists of the following fields:

{https}://{host address}/{service name}/{resource name}?{request parameter strings 1}&{request parameter strings 2}&api_key={your API key}

Note:

§         Use / to separate the host address, organization ID, API version, resource path and name.

§         Use ? to separate the full API path and request parameters.

§         Use & to separate the optional request parameters. Note that optional request parameters do not have to be listed in a specific order.

§         Use = to separate parameter names and parameter values.

§         Use , to separate multiple parameter values for one parameter name (note that only specific parameters can accept more than one value).

For example:

§         Refer to the List of Insights Data APIs to view API specifications for the required API.

o        To retrieve summary information for customers whose first name are John and last name are Smith:

♦      The required API to retrieve customer information is customers

♦      For the first name filter,  firstName=John

♦      For the last name filter, lastName=Smith

§         Your service name is ANETGateway/rest/anet-insightsapi/

§         Your API key is specified as api_key=1234567890xn3xnteudxsavw

The request URL is:

Request parameters

To see the available request parameters for an API, refer to each individual API specifications.

API request parameters can either be mandatory or optional:

• Mandatory request parameters:

Mandatory request parameters must be specified in the URL path of your API request.

Example: To call the Membership Statistics API, you must specify the requested start date and end date in the URL path.

Example URL:

Only memberships whose transferred-in dates are between 2017-01-01 and 2017-01-02 will be returned.

• Optional request parameters:

You can include several optional request parameters in the URL to filter the response results.

Example: To call the Membership Statistics API, you can specify the following optional request parameters:

Membership packages under Site IDs 101 and 102: siteId=101,102

Example URL:

Only memberships in sites 101 and 102, and whose transferred-in dates are between 2017-01-01 and 2017-01-02 will be returned.

Note:

URL parameters may require special characters; for the corresponding escape string, refer to the table below:

Receiving API responses

Once you make a request to the API with the required parameters, you will receive an API response.

A successful request returns the HTTP 200 OK status code and a JSON-formatted response body.

For more information on response fields, refer to the each individual API.

For more information about error handling, refer to Error handling.

Related topics

Getting Started Guide

Authentication

Common parameters

Error handling

Terms of Use