User Activities – Extended


Request Details

Item Value
Description Returns a list of available activities to a user. This endpoint returns the enhanced set of activity attribute details.
Method GET
Endpoint https://api.crowdtwist.com/v2/users/[user_id]/activities/extended?api_key=[api_key]&id_type=[id_type]


Request

Field Name Sample Value Required Format Notes
URL PARAMETERS
user_id alice@crowdtwist.com Yes String Unique ID of the user for whom activities will be returned:
Options:
– Email Address
– Facebook User ID
– Twitter User ID
– CrowdTwist ID
– Third Party ID
– Username
– Mobile Phone Number
QUERY STRING PARAMETERS
api_key QWERTYUIOP Yes String  
id_type email No String Type of ID being Sent:
Options:
– email
– facebook_user_id
– twitter_user_id
– id (CrowdTwist ID) – default ID if id_type is not specified
– third_party_id
– username
– mobile_phone_number


Successful Response

Field Name Sample Value Required Format Description
id 64 Yes   Internal CrowdTwist Activity ID
name watched a video Yes   The name of the activity
title Watched A Video Yes   The title of the activity
description Watched A Video Yes   The description of the activity
num_points 25 Yes   The number of points an activity is worth
image https://crowdtwist.com/img/v2/image.jpg Yes   The URL to the activity image
category_id 3 Yes   An internal CrowdTwist Category ID that corresponds to the category_name; 1-4
category_name Interact Yes   The name of the category assigned to the activity
  1 = Share
  2 = Socialize
  3 = Interact
  4 = Buy
type_id 7 Yes   An internal CrowdTwist Type ID that corresponds to the type_id; 1-8
type_name Your Site Yes   The type of activity
  1 = Facebook
  2 = Merchandise
  3 = Music
  4 = Tickets
  5 = Twitter
  6 = Your Site
  7 = Check-In
  8 = Code Redemption
activity_channel_id null no   Internal Activity Channel ID that corresponds to activity channel
name; 1-26
activity_channel_name null no   Activity Channel
  1 = ad hoc points
  2 = code redemption cgp
  3 = code redemption other
  4 = content creation and share
  5 = content download
  6 = donation
  7 = email open or click
  8 = email sent from member via program
  9 = facebook
  10 = foursquare
  11 = game played
  12 = Instagram
  13 = Mobile client app
  14 = Mobile partner app
  15 = Program login
  16 = Purchase merchandise
  17 = Purchase season ticket or subscription
  18 = Purchase ticket
  19 = Registration and profile
  20 = Reward redemption
  21 = Survey
  22 = Sweeps
  23 = Twitter
  24 = Web client site activity
  25 = Web other site activity
  26 = Web partner site activity
freq_cap 1 Yes   The number of times a member can complete an activity
freq_period_id 2 Yes   The internal frequency period id; 1-9
freq_period_name One Calendar Day Yes   The period of time before members can re-earn points for
completing the activity.
  1 = 24 Hours (Inactive)
  2 = One Calendar Day
  3 = Seven Calendar Days (Inactive)
  4 = One Calendar Week
  5 = Lifetime
  6 = One Calendar Month
  7 = One Calendar Year (Inactive)
  8 = 365 Days (Inactive)
  9 = 30 Days (Inactive)
freq_num_required_attempts null No   The number of times the activity must completed before points are awarded
redirect_url www.crowdtwist.com No   Redirect URL that the member is taken to when selecting on certain the activity titles (e.g. point-on-click; JS Tag)
points_on_click true Yes   Denotes whether an activity is a point on click
action_tags null No   The JavaScript tag that is used to award points for activities that are tracked via JS Tag
extra_data null No    
public_title Watch A Video Yes   The member-facing title of the activity
public_description Daily Points for every video! Yes   The member-facing description of the activity
date_start 1508167798 No Date Start date of activity
date_end 1510846197 No Date End date of activity
min_tier_id null No String The minimum tier that a user needs to be at in order to perform this activity. List of ID values will be provided by the CrowdTwist team.
is_hidden_by_tier false No Boolean Indicates whether the activity is hidden or not to the user
is_locked_by_tier false No Boolean Indicates whether the activity is locked or not for the user


Error Response

Field Name Sample Value Required Format Description
error param_error Yes String A machine readable code that describes the error.
message User does not exist Yes String A short, descriptive sentence detailing the error.


Error Response Codes

Error Message
input_error The input provided in invalid or formatted incorrectly.
internal_error Something went wrong on our end.
no data There are no activities available to this client.
invalid_auth Invalid access credentials


Sample Request

curl -X GET
'https://api.crowdtwist.com/v2/users/alice@crowdtwist.com/activities/extended?api_key=QWERTYUIOP&id_type=email'
curl -X GET
'https://api.crowdtwist.com/v2/users/alice@crowdtwist.com/activities/extended?api_key=QWERTYUIOP&id_type=email'


Sample Successful Response: Status Code 200

[
  {
    "id": 198,
    "name": "added gender",
    "title": "Added Genders",
    "description": "Added Gender",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/a40753af2be182894274c3c5d542244677a11a90/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": null,
    "freq_period_id": null,
    "freq_period_name": null,
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Added Genders",
    "public_description": "Get points for updating your profile"
  },
  {
    "id": 410045391,
    "name": "invited friends",
    "title": "Invited Friends",
    "description": "Invited Friends",
    "num_points": 400,
    "image": "https://cdn.crowdtwist.com/img/v2/25302b403f5f6afffbe338c8380e6cbbb2f05c2f/100/100/0/image.jpg",
    "category_id": "3",
    "category_name": "Interact",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "2",
    "freq_period_id": "1",
    "freq_period_name": "24 hours",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Invited Friends",
    "public_description": "Invited A Friend"
  },
  {
    "id": 206,
    "name": "added date of birth",
    "title": "Added Date of Birth",
    "description": "Added Date of Birth",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/01b14777d494871bb762731445cc60b3d478a1a0/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "1",
    "freq_period_id": "5",
    "freq_period_name": "Lifetime",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Added Date of Birth",
    "public_description": "Get points for updating your profile"
  },
  {
    "id": 205,
    "name": "first month facebook fanship",
    "title": "First Month Facebook Fanship",
    "description": "First Month Facebook Fanship",
    "num_points": 0,
    "image": "https://cdn.crowdtwist.com/img/v2/35993ed3f6810269972a697af650881d94361b10/100/100/0/image.jpg",
    "category_id": "2",
    "category_name": "Socialize",
    "type_id": "1",
    "type_name": "Facebook",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": null,
    "freq_period_id": null,
    "freq_period_name": null,
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Like CrowdTwist",
    "public_description": "Get monthly points as a fan"
  },
  {
    "id": 200,
    "name": "daily login",
    "title": "Daily Login",
    "description": "Daily Login",
    "num_points": 10,
    "image": "https://cdn.crowdtwist.com/img/v2/996a3a61c07ced23d1b88630c41456de29619fcf/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "1",
    "freq_period_id": "2",
    "freq_period_name": "One calendar day",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "date_start": null,
    "date_end": null,
    "min_tier_id": null,
    "is_hidden_by_tier": false,
    "is_locked_by_tier": false,
    "public_title": "Daily Login",
    "public_description": "Check us out every day & earn points"
  },
  {
    "id": 410044807,
    "name": "read article",
    "title": "Read Article",
    "description": "Read Article",
    "num_points": 5,
    "image": "https://cdn.crowdtwist.com/img/v2/75b9a8d37fc2da67111772baeeeb467868f9220b/100/100/0/image.jpg",
    "category_id": "3",
    "category_name": "Interact",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "3",
    "freq_period_id": "4",
    "freq_period_name": "One calendar week",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": "ct_trck_article",
    "extra_data": null,
    "date_start": null,
    "date_end": null,
    "min_tier_id": null,
    "is_hidden_by_tier": false,
    "is_locked_by_tier": false,
    "public_title": "Read an Article",
    "public_description": "Daily points for keeping up with the latest"
  }
]
[
  {
    "id": 198,
    "name": "added gender",
    "title": "Added Genders",
    "description": "Added Gender",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/a40753af2be182894274c3c5d542244677a11a90/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": null,
    "freq_period_id": null,
    "freq_period_name": null,
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Added Genders",
    "public_description": "Get points for updating your profile"
  },
  {
    "id": 410045391,
    "name": "invited friends",
    "title": "Invited Friends",
    "description": "Invited Friends",
    "num_points": 400,
    "image": "https://cdn.crowdtwist.com/img/v2/25302b403f5f6afffbe338c8380e6cbbb2f05c2f/100/100/0/image.jpg",
    "category_id": "3",
    "category_name": "Interact",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "2",
    "freq_period_id": "1",
    "freq_period_name": "24 hours",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Invited Friends",
    "public_description": "Invited A Friend"
  },
  {
    "id": 206,
    "name": "added date of birth",
    "title": "Added Date of Birth",
    "description": "Added Date of Birth",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/01b14777d494871bb762731445cc60b3d478a1a0/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "1",
    "freq_period_id": "5",
    "freq_period_name": "Lifetime",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Added Date of Birth",
    "public_description": "Get points for updating your profile"
  },
  {
    "id": 205,
    "name": "first month facebook fanship",
    "title": "First Month Facebook Fanship",
    "description": "First Month Facebook Fanship",
    "num_points": 0,
    "image": "https://cdn.crowdtwist.com/img/v2/35993ed3f6810269972a697af650881d94361b10/100/100/0/image.jpg",
    "category_id": "2",
    "category_name": "Socialize",
    "type_id": "1",
    "type_name": "Facebook",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": null,
    "freq_period_id": null,
    "freq_period_name": null,
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Like CrowdTwist",
    "public_description": "Get monthly points as a fan"
  },
  {
    "id": 200,
    "name": "daily login",
    "title": "Daily Login",
    "description": "Daily Login",
    "num_points": 10,
    "image": "https://cdn.crowdtwist.com/img/v2/996a3a61c07ced23d1b88630c41456de29619fcf/100/100/0/image.jpg",
    "category_id": "1",
    "category_name": "Share",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "1",
    "freq_period_id": "2",
    "freq_period_name": "One calendar day",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "date_start": null,
    "date_end": null,
    "min_tier_id": null,
    "is_hidden_by_tier": false,
    "is_locked_by_tier": false,
    "public_title": "Daily Login",
    "public_description": "Check us out every day & earn points"
  },
  {
    "id": 410044807,
    "name": "read article",
    "title": "Read Article",
    "description": "Read Article",
    "num_points": 5,
    "image": "https://cdn.crowdtwist.com/img/v2/75b9a8d37fc2da67111772baeeeb467868f9220b/100/100/0/image.jpg",
    "category_id": "3",
    "category_name": "Interact",
    "type_id": "7",
    "type_name": "Your Site",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "3",
    "freq_period_id": "4",
    "freq_period_name": "One calendar week",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": "ct_trck_article",
    "extra_data": null,
    "date_start": null,
    "date_end": null,
    "min_tier_id": null,
    "is_hidden_by_tier": false,
    "is_locked_by_tier": false,
    "public_title": "Read an Article",
    "public_description": "Daily points for keeping up with the latest"
  }
]

Sample Error Response: Status Code 400

{
  "error": "page_not_found",
  "message": "user does not exist."
}
{
	"error": "page_not_found",
	"message": "user does not exist."
}