Activities – Extended


Request Details

Item Value
Description Returns the list of active activities for a specific client. This endpoint returns the enhanced set of activity attribute details.
Method GET
Endpoint https://api.crowdtwist.com/v2/activities/extended?api_key=[api_key]


Request

Field Name Sample Value Required Format Notes
URL PARAMETERS  – none      
QUERY STRING PARAMETERS      
api_key QWERTYUIOP Yes String  


Successful Response

Field Name Sample Value Required Format Description
id 64 Yes String Internal CrowdTwist activity id
name Watched A Video Yes String The name of the activity
title Watched A Video Yes String The title of the activity
description Watched A Video Yes String The description of the activity
num_points 25 Yes Interger The number of points an activity is worth
image The URL to the activity image Yes URL 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 6 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   The channel type
  1 = Ad hoc points
  2 = Code redemption cap
  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 No   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


Error Response

Field Name Sample Value Required Format Description
error param_error Yes String A machine readable code that describes the error.


Error Response Codes

Error Error Code Message
param_error 400 A missing or invalid parameter is included in the request
invalid_auth 400 Invalid access credentials
no data 404 There are no activities available to this client
internal_error 500 Something went wrong on our end


Sample Request

curl -X GET
https://api.crowdtwist.com/v2/activities/extended?api_key=QWERTYUIOP
curl -X GET
https://api.crowdtwist.com/v2/activities/extended?api_key=QWERTYUIOP


Sample Successful Response: Status Code 200

[
  {
    "id": "410045996",
    "name": "redeemed a code",
    "title": "Redeemed a Code",
    "description": "Redeemed a Code",
    "num_points": 1000,
    "image": "https://cdn.crowdtwist.com/img/v2/28eaf56053b7ecdd2ad068b09f69e1796124f414/100/100/0/image.jpg",
    "category_id": "4",
    "category_name": "Buy",
    "type_id": "2",
    "type_name": "Merchandise",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "2",
    "freq_period_id": "4",
    "freq_period_name": "One calendar week",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "redeemed a code",
    "public_description": "redeemed a code"
  },
  {
    "id": "410044792",
    "name": "reviewed a product",
    "title": "Reviewed a Product",
    "description": "Reviewed a Product",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/63e9cd65a9f2dedbaec4468cf445611efad93f89/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": "1",
    "freq_period_id": "6",
    "freq_period_name": "One calendar month",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Reviewed a Product",
    "public_description": "Get points for reviewing a product"
  },
  {
    "id": "196",
    "name": "sign in with twitter",
    "title": "Sign in with Twitter",
    "description": "Sign in with Twitter",
    "num_points": 100,
    "image": "https://cdn.crowdtwist.com/img/v2/4ce0bec09fa4fd1c83dbe50b975209b5292a06ab/100/100/0/image.jpg",
    "category_id": "2",
    "category_name": "Socialize",
    "type_id": "6",
    "type_name": "Twitter",
    "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": "Connect To Twitter",
    "public_description": "Get points for syncing your account to Rewards"
  },
  {
    "id": "410044884",
    "name": "started recurring product subscription",
    "title": "Started Recurring Product Subscription",
    "description": "Started Recurring Product Subscription",
    "num_points": 0,
    "image": "https://cdn.crowdtwist.com/img/v2/c9d87a70514014d22dc7b99979dc95866bfec7b2/100/100/0/image.jpg",
    "category_id": "4",
    "category_name": "Buy",
    "type_id": "2",
    "type_name": "Merchandise",
    "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": "Started Recurring Production Subscription",
    "public_description": "Started Recurring Production Subscription"
  }
]        
[
  {
    "id": "410045996",
    "name": "redeemed a code",
    "title": "Redeemed a Code",
    "description": "Redeemed a Code",
    "num_points": 1000,
    "image": "https://cdn.crowdtwist.com/img/v2/28eaf56053b7ecdd2ad068b09f69e1796124f414/100/100/0/image.jpg",
    "category_id": "4",
    "category_name": "Buy",
    "type_id": "2",
    "type_name": "Merchandise",
    "activity_channel_id": null,
    "activity_channel_name": null,
    "freq_cap": "2",
    "freq_period_id": "4",
    "freq_period_name": "One calendar week",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "redeemed a code",
    "public_description": "redeemed a code"
  },
  {
    "id": "410044792",
    "name": "reviewed a product",
    "title": "Reviewed a Product",
    "description": "Reviewed a Product",
    "num_points": 250,
    "image": "https://cdn.crowdtwist.com/img/v2/63e9cd65a9f2dedbaec4468cf445611efad93f89/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": "1",
    "freq_period_id": "6",
    "freq_period_name": "One calendar month",
    "freq_num_required_attempts": null,
    "redirect_url": null,
    "points_on_click": false,
    "action_tags": null,
    "extra_data": null,
    "public_title": "Reviewed a Product",
    "public_description": "Get points for reviewing a product"
  },
  {
    "id": "196",
    "name": "sign in with twitter",
    "title": "Sign in with Twitter",
    "description": "Sign in with Twitter",
    "num_points": 100,
    "image": "https://cdn.crowdtwist.com/img/v2/4ce0bec09fa4fd1c83dbe50b975209b5292a06ab/100/100/0/image.jpg",
    "category_id": "2",
    "category_name": "Socialize",
    "type_id": "6",
    "type_name": "Twitter",
    "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": "Connect To Twitter",
    "public_description": "Get points for syncing your account to Rewards"
  },
  {
    "id": "410044884",
    "name": "started recurring product subscription",
    "title": "Started Recurring Product Subscription",
    "description": "Started Recurring Product Subscription",
    "num_points": 0,
    "image": "https://cdn.crowdtwist.com/img/v2/c9d87a70514014d22dc7b99979dc95866bfec7b2/100/100/0/image.jpg",
    "category_id": "4",
    "category_name": "Buy",
    "type_id": "2",
    "type_name": "Merchandise",
    "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": "Started Recurring Production Subscription",
    "public_description": "Started Recurring Production Subscription"
  }
]        

Sample Error Response: Status Code 400

{
  "error": "param_error",
  "message": "A missing or invalid parameter is included in the request"
}
{
	"error": "param_error",
	"message": "A missing or invalid parameter is included in the request"
}