For APIs that return multiple records, optional pagination is available. It is recommended that pagination is used for APIs that may return large amounts of data. To see if pagination is supported for an API, refer to the individual API specification.
Note that pagination works differently for the Activity Enrollments API and the Memberships API. For more information, refer to refer to the API specification for these two APIs.
In the request URL, the following pagination parameters can be included:
| Item | Type | Description |
page |
int | The requested page (if not specified, then page 1 is returned by default) |
pageSize |
int |
Number of records per page (if not specified, then 100 records are returned per page by default) |
The response contains the following pagination information:
| Item | Type | Description |
| page | int | Requested page number |
| pageSize | int | Number of records per page |
| pageRowCount | string | Number of records on the Index page |
| filteredRowCount | string | Number of results filtered by the query parameters |
| data | array | List of records |
For example:
To:
display 10 customers per page
view the second page
Refer to the following request URL:
https://api.amp.active.com/ANETGateway/rest/anet-insightsapi/customers?pageSize=10&page=2&api_key=xxx
Example response:
{
"page": 2,
"pageSize": 3,
"pageRowCount": 3,
"filteredRowCount": 254786,
"totalRowCount": 254786,
"data": [
{
"customer_id": 9,
"site": "Site A01",
"firstname": "Andrew",
"lastname": "Blue",
"gender": "Other",
"headofhousehold": "No",
"resident_status": "Non-resident",
"specialhandling": "No",
"date_modified": "2014-09-29 09:13:40.0",
"retired_status": "Active",
"not_online_activated": "No",
"can_be_scheduled": "No",
"agree_receive_text_message": "No",
"created_on": "Unknown"
},
{
"customer_id": 10,
"firstname": "Andy",
"lastname": "Green",
"entrydate": "2013-06-18 07:49:25.0",
"gender": "Other",
"headofhousehold": "No",
"resident_status": "Non-resident",
"specialhandling": "No",
"date_modified": "2013-10-21 09:33:14.0",
"retired_status": "Active",
"not_online_activated": "No",
"can_be_scheduled": "No",
"agree_receive_text_message": "No",
"created_on": "Staff side"
},
{
"customer_id": 11,
"firstname": "Blake",
"lastname": "Smith",
"address1": "135 Street #2",
"city": "Hill Park",
"state": "CA",
"zipcode": "91706",
"homephone": "123456789",
"workphone": "987654321",
"cellphone": "123454321",
"email": "bettysmith@email.net",
"birthdate": "1984-01-12 00:00:00.0",
"entrydate": "2013-07-12 15:36:06.0",
"gender": "Male",
"headofhousehold": "No",
"resident_status": "Non-resident",
"specialhandling": "No",
"emergency_contact1_first_name": "Nancy",
"emergency_contact1_last_name": "Smith",
"emergency_contact1_phone_no": "123456789",
"emergency_contact1_relation": "Wife",
"date_modified": "2017-07-10 08:04:26.0",
"retired_status": "Active",
"not_online_activated": "No",
"login_created": "2013-12-12 12:27:42.0",
"login_used": "2016-07-11 15:24:14.0",
"county": "Los Angeles",
"can_be_scheduled": "No",
"agree_receive_text_message": "Yes",
"created_on": "Staff side"
}
]
}
Retrieving data from ACTIVE Net Insights