Appreciation Engine

Open navigation

AE REST API Permissions (Basic & Advanced)


Basic Permissions


Available on Free and Enterprise accounts:


auth, info, cross_brands, cross_activity, brandlist,


feed, segments, activities, app_info,


members, check, member, member_update, member_register, member_delete, reset_password, member_registrations, member_domains,


gender_breakdown, age_breakdown, activity_breakdown, social_network_breakdown, activity_breakdown_totals,


activity_breakdown_timeline, location_breakdown, active_members_breakdown, members_registration_timeline, members_registration_channels,


members_registration_domains, members_registration_totals, community, members_visit_totals, members_activity_totals

account_usage


Advanced Permissions


Available only on Enterprise accounts:


record, optin, optout, segment_save, segment_delete, activity_save, activity_delete, app_allowlist, app_unallowlist, member_verify, member_refresh_tokens




AE REST API Calls (Version & Permission Requirements)



API Version 1.1:


Version

API Call

Permission Level Needed For Access

v1.1

activities

Basic

v1.1

activities/create 

Basic

v1.1

activities/[ActivityID]/edit

Advanced

v1.1

activities/[ActivityID]/delete

Advanced

v1.1

activity/feed

Basic

v1.1

activity/record

Advanced

v1.1

app/info

Basic

v1.1

app/unallowlist

Advanced

v1.1

app/allowlist

Advanced

v1.1

auth

Basic

v1.1

brands

Basic

v1.1

brands/create

Basic

v1.1

brand/[BrandID] 

Basic

v1.1

brand/[BrandID]/edit

Basic

v1.1

brand/[BrandID]/stats/activity

Basic

v1.1

brand/[BrandID]/stats/age

Basic

v1.1

brand/[BrandID]/delete

Basic

v1.1

brand/[BrandID]/crossover

Basic

v1.1

brand/[BrandID]/segments

Basic

v1.1

brand/[BrandID]/activities

Basic

v1.1

brand/[BrandID]/stats/gender 

Basic

v1.1

brand/[BrandID]/stats/timeline

Basic

v1.1

brand/[BrandID]/stats/location

Basic

v1.1

brand/[BrandID]/stats/members

Basic

v1.1

members/all

Basic

v1.1

members/login

Basic

v1.1

members/extended

Basic

v1.1

members/active

Basic

v1.1

member/login

Basic

v1.1

member/register

Basic

v1.1

member/[MemberID]

Basic

v1.1

member/[MemberID]/verify

Basic

v1.1

member/[MemberID]/delete

Basic

v1.1

member/[MemberID]/update

Basic

v1.1

member/[MemberID]/domains/top

Basic

v1.1

member/[MemberID]/domains/logins

Basic

v1.1

member/[MemberID]/activity/delete

Basic

v1.1

member/refresh/tokens

Advanced

v1.1

member/[MemberID]/reset 

Advanced

v1.1

login/stats/totals

Basic

v1.1

login/stats/domains 

Basic

v1.1

login/stats/channels

Basic

v1.1

login/stats/timeline

Basic

v1.1

optin

Basic

v1.1

optin/brand/[BrandID] 

Basic

v1.1

optin/segment/[SegmentID]

Basic

v1.1

optout

Basic

v1.1

optout/brand/[BrandID]

Basic

v1.1

optout/segment/[SegmentID]

Basic

v1.1

segments

Basic

v1.1

segments/create

Basic

v1.1

segments/[SegmentID]/edit 

Advanced

v1.1

segments/[SegmentID]/delete

Advanced




API Version 1.0:


Version

API Call

Permission Level Needed For Access

v1.0

activities

Basic

v1.0

activity_breakdown_timeline

Basic

v1.0

activity_breakdown_totals

Basic

v1.0

activity_save

Advanced

v1.0

activity_delete

Advanced

v1.0

age_breakdown

Basic

v1.0

app_info

Basic

v1.0

app_allowlist

Basic

v1.0

app_unallowlist

Advanced

v1.0

auth

Basic

v1.0

brandlist

Basic

v1.0

check

Basic

v1.0

cross_brands

Basic

v1.0

feed

Basic

v1.0

gender_breakdown

Basic

v1.0

info

Basic

v1.0

location_breakdown

Basic

v1.0

members

Basic

v1.0

members_registration_totals

Basic

v1.0

members_registration_timeline

Basic

v1.0

member

Basic

v1.0

member_register

Basic

v1.0

member_delete

Basic

v1.0

member_update

Basic

v1.0

member_refresh_tokens

Advanced

v1.0

member_verify

Advanced

v1.0

optin

Advanced

v1.0

optout

Advanced

v1.0

reset_password

Basic

v1.0

record

Advanced

v1.0

segments

Basic

v1.0

segment_save

Advanced

v1.0

segment_delete

Advanced

v1.0

top

Basic

v1.0

user

Basic



Test api endpoints by using the console at our developer site.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.