Filtering Responses

Some GET methods provide optional filter parameters you can include to narrow API results based on various criteria. The following sections show how to use some filter parameters to get data on campaigns, donations, and users. This page contains the following topics:

Filtering Campaign Results
Filtering Donation Results
Filtering User Results

Use one of the following URLs to open the API reference:
Test system: https://demo.360alumni.com/api/doc/
Your system: https://<<your-system>>.360alumni.com/api/doc</your-system>

‍

Filtering Campaign Results

The following steps walk you through using a filter parameter to get data on campaigns.

1. Click the GET /api/campaigns/ method.
Optional filter parameters include created_since and created_before. Use these parameters to narrow the campaigns returned to within a specific time frame.

2. Click Sandbox to display the form for entering values and trying the request.
For this example we'll narrow the results to those campaigns created since August 1, 2017.

A) Enter your API key in an HTTP request header.

B) Enter the value 2017-08-01 for the created_since parameter.

C) Click Try! to execute the API request.

3. The Response Body shows the JSON results.
Note the values for the createdAt field are more recent than the value input for created_since.

Filtering Donation Results

The following steps walk you through using filter parameters to get data on donations.

1. Click the GET /api/donations/ method. Note the following:
Optional parameters to filter the results include campaign_id, user_id, start_date, and end_date.

2. Click Sandbox to display the form for entering values and trying requests.

3. First we'll request all the donations.
A) Enter your API key in an HTTP request header.
B) Click Try! to execute the API request.

4. The Response Body contains a JSON array of Donation Objects that includes all donations. The following image shows a few of these results. Note the following:
Donation object fields correspond to the filter parameters campaign_id and user_id for GET /api/donations/ requests.
The created_at field determines the results of a GET /api/donations/ request if you use the start_date or end_date filter parameters.

5. The next request filters donations by user_id.
A) Enter 1102 for the user_id value.
B) Click Try! to execute the API request.

6. Note the results contain a few donation objects.

Filtering User Results

The following steps walk you through using filter parameters to get data on users.

1. Click the GET /api/users/ method.

2. Click Sandbox to display the form for entering values and trying requests.

3. Note there are a great number of optional parameters available to filter the results.

4. First we'll request all users that are not yet approved.
A) Enter your API key in an HTTP request header.
B) Enter the value 0 for the approved field. A 1 represents approved and a 0 represents not approved.
C) Click Try! to execute the API request.

5. The Response Body contains a JSON array of user objects where the approved field value is 0.

6. The next request filters for all approved users that are not enabled.
A) Enter the value 1 for the approved field.
B) Enter the value 0 for the enabled field. A 1 represents enabled accounts and a 0 represents accounts that are not enabled.
C) Click Try! to execute the API request.

7. Note the results contain fewer user records.

8. Click a down arrow in the Response Body to collapse the view of an object's fields.

‍

JSON Donation Object Sample

The following JSON Donation object is suitable for copying.

[
{
"id": "14",
"campaign_id": 16,
"user_id": 1102,
"first_name": "Maria",
"last_name": "Reile",
"amount": 15,
"created_at": "2013-12-12 22:59:38",
"transaction_id": "5770260782"
}
]

Ambassador Object

JSON Campaign Object Sample

{
"id": 17,
"title": "Aspiring Director's Fund",
"details": "<p>The Motion Picture Association (MPA) and the Asia Pacific Screen Awards (APSA) gives an opportunity to aspiring filmmakers with the MPA APSA Academy Film Fund. MPA APSA Academy Film Funds is a unique initiative which has aided aspiring film makers in a lot of development in new film projects.</p>",
"goal": 501,
"thank_you_message": "Dear #name#,\r\n\r\nThank you for your $#amount# donation to the #title# campaign! We truly appreciate your support.\r\nEvery bit helps, and you've taken us one step closer to achieving our goal.\r\nCheck back often to see which of your friends have donated, and the progress we've made. \r\n\r\nThanks for helping us to make this our most successful year yet!\r\n\r\nSincerely, 360Alumni Support",
"type": "short",
"start_date": "2013-11-15 00:00:00",
"end_date": "2017-01-31 00:00:00",
"createdAt": "2013-11-15 17:33:07",
"updatedAt": "2016-06-16 11:42:09",
"isInactive": null,
"author": {
"user_id": 1092,
"first_name": "Georgette",
"last_name": "Lucas"
},
"raised": "465",
"image": "/cdn/images/f19cb30cf19d512a9de8f487a5bc1d13.jpg",
"ambassadors": [
{
"user_id": 1103,
"first_name": "Ken",
"last_name": "Richardson"
}
]
}

about

text

A text description of the user.

activated_at

string (255)

The date the user's account was activated.

YYYY-MM-DD Year-Month-Day

admin_notes

text

Notes by the client administrator.

approved

number (6)

1, 0

The user's approval status.
1: The user's account is approved.
0: The user's account is not approved.

bad_email

number (11)

1, 0

The status of the validity of the email address. See also the email field.
1: Email is valid.
0: Email is not valid.

client_id

number (11)

The client ID.

createdAt

string (255)

The date the user's account was created.

YYYY-MM-DD Year-Month-Day

custom_fields

array

An array of optional custom-defined fields.

{"custom-field-name" : "custom-field-value" },

dob_day

number (11)

01 - 31

Date of birth day. The two digit day in the month of the user's birth day.

DD

dob_month

number (11)

01 - 12

Date of birth month. The two digit month of the user's birth day.

MM

dob_year

number (11)

Date of birth year. The year of the user's birthday.

YYYY

email*

string (255)

The user's email address

emma_member_id

string (255)

The user's EMMA member number from the EMail Marketing Association.

enabled

number (11)

1, 0

The status of whether the user's account is enabled or not.
1: enabled
0: not enabled

facebook_link

string (255)

The user's facebook URL link.

URL

first_login

number (11)

1, 0

The status of whether the user has logged in for the first time.
1: The user has logged in at least once.
0: The user has not logged in yet.

first_name*

string (255)

User's first name.

gender

character (1)

m, f

The user's gender.

groups

array

An array of optional user group names (string) of which this user is a member.
For example, "admin", "read-only", and so on.

groups [ "group-name1", "group-name2" ]

hard_bounce

number (11)

Number of email hard bounces.
When an email is rejected by a subscriber's email server due to a permanent delivery error, it's called a hard bounce.

home_address1

string (255)

The first line of the home address.

home_address2

string (255)

The second line of the home address.

home_city

string (255)

The city of the home address.

home_country

number (11)

The two-letter postal abbreviation for the country of the home address.

home_geohash

The home geographic location in the geohash form of a short string of letters and digits.

home_geohash_l1

The home geohash value to 1 digit precision.

home_geohash_l2

The home geohash value to 2 digit precision.

home_geohash_l3

The home geohash value to 3 digit precision.

home_geohash_l4

The home geohash value to 4 digit precision.

home_geohash_l5

The home geohash value to 5 digit precision.

home_geohash_l6

The home geohash value to 6 digit precision.

home_lat

number (10.7)

The geographical latitude of the home address.

home_lng

number (10.7)

The geographical longitude of the home address.

home_phone

string (255)

User's home telephone number.

home_state

number (11) ?

The two-letter postal abbreviation for the state of the home address.

SS

home_zipcode

string (255)

The postal zip code of the home address.

#####[-####]

image

A picture of the user.

inst_id

string (255)

instagram_link

string(255)

The user's Instagram URL link.

URL

isConfirmed

1, 0

isPrimary

1, 0

is_import_user

number (6)

1, 0

The status of whether the user's account was created from an import or not.
1: The user's account is imported.
0: The user's account is not imported.

last_activity_at

string (255)

The date of last activity for the user's record.

YYYY-MM-DD Year-Month-Day

last_login

string (255)

The date the user last logged in.

YYYY-MM-DD Year-Month-Day

last_name*

string (255)

The user's last name.

linkedin_link

string (255)

The user's LinkedIn URL link.

URL

maiden_name

string (255)

The user's maiden name.

middle_name

string (255)

The user's middle name.

mobile_phone

string (255)

The user's mobile phone number.

name_suffix

A name suffix (such as PhD or Jr.)

name_title

A name title (such as Ms, Mr, Dr.)

nickname

string (255)

A user's nickname.

preferred_email

number (6)

The user's preferred email.

preferred_phone

number (6)

The user's preferred email.

profile_url

string (255)

Personal URL. Allow to access own personal profile page.

salt

string (255)

secondary_email

string (255)

A secondary user email.

soft_bounce

number (11)

The number of email soft bounces.
When an email is rejected by a subscriber's email server due to a temporary email delivery issue, it's called a soft bounce.