Profiles API Methods
Viralheat is a social media measurement platform that allows you to track topics, brands, television shows, and movies across many different mediums all in one place using the best technology. Profile API calls allows you to export details of the all the profiles running in your account.
Available Methods
Method 1: Create a ProfileMethod 2: Edit a Profile
Method 3: Delete a Profile
Method 4: List all Profiles
Method 5: List details for a Profile
Method 6: List all alerts for a Profile
Method 1: Create a Profile
URL: http://www.viralheat.com/api/profile/create?api_key=[*** your api key ***]&expression=caltrainFormat: XML
HTTP Method: POST
Requires Authentication: Yes
Parameters:
api_key (mandatory): the authenticated account key.
expression (mandatory): the search expression to setup tracking in Viralheat
name (optional): name of the profile.
location (optional): if you want to restrict the search to a specific location.
note: Location should be specified in (City, Country) format. Eg. Munich, Germany
radius (optional): this parameter is only valid when the location parameter is specified. This allows the user to restrict the location based search within specified radius.
note: Radius should be less than 2000km
email: to turn ON nightly email for the accounts.
public: to specify if the profile should be shared on Social trends. By sharing your profile, you allow the community to comment on your profile and make suggestions that will yield you better results. Sharing also allows you to make a small subset of data available to the public.
category: This is used for classification of your profiles.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
expression (mandatory): the search expression to setup tracking in Viralheat
name (optional): name of the profile.
location (optional): if you want to restrict the search to a specific location.
note: Location should be specified in (City, Country) format. Eg. Munich, Germany
radius (optional): this parameter is only valid when the location parameter is specified. This allows the user to restrict the location based search within specified radius.
note: Radius should be less than 2000km
email: to turn ON nightly email for the accounts.
public: to specify if the profile should be shared on Social trends. By sharing your profile, you allow the community to comment on your profile and make suggestions that will yield you better results. Sharing also allows you to make a small subset of data available to the public.
category: This is used for classification of your profiles.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
Return Values:
id: unique id referencing a profile in the system.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
radius: radius in which the search should be performed (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
radius: radius in which the search should be performed (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<profile>
<id>8804</id>
<expression>caltrain</expression>
<name>caltrain</name>
<created_at>2010-02-02 01:24:44 UTC</created_at>
<deliver_email>1</deliver_email>
<longitude>-122.4194155</longitude>
<latitude>37.7749295</latitude>
<radius>2000</radius>
<location> san francisco</location>
<public>1</public>
<category>general</category>
<status>Success: Profile was created.</status>
</profile>
Method 2: Edit a Profile
URL: http://www.viralheat.com/api/profile/edit?api_key=[*** your api key ***]&profile_id=8805&expression=caltrainFormat: XML
HTTP Method: POST
Requires Authentication: Yes
Parameters:
api_key (mandatory): the authenticated account key.
profile_id (mandatory): specify the profile_id that you want to edit.
expression (mandatory): edit the search expression to setup new tracking in Viralheat
name (optional): name of the profile.
location (optional): if you want to restrict the search to a specific location.
note: Location should be specified in (City, Country) format. Eg. Munich, Germany
radius (optional): this parameter is only valid when the location parameter is specified. This allows the user to restrict the location based search within specified radius.
note: Radius should be less than 2000km
email: to turn ON nightly email for the accounts.
public: to specify if the profile should be shared on Social trends. By sharing your profile, you allow the community to comment on your profile and make suggestions that will yield you better results. Sharing also allows you to make a small subset of data available to the public.
category: This is used for classification of your profiles.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
profile_id (mandatory): specify the profile_id that you want to edit.
expression (mandatory): edit the search expression to setup new tracking in Viralheat
name (optional): name of the profile.
location (optional): if you want to restrict the search to a specific location.
note: Location should be specified in (City, Country) format. Eg. Munich, Germany
radius (optional): this parameter is only valid when the location parameter is specified. This allows the user to restrict the location based search within specified radius.
note: Radius should be less than 2000km
email: to turn ON nightly email for the accounts.
public: to specify if the profile should be shared on Social trends. By sharing your profile, you allow the community to comment on your profile and make suggestions that will yield you better results. Sharing also allows you to make a small subset of data available to the public.
category: This is used for classification of your profiles.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
Return Values:
id: unique id referencing a profile in the system.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
radius: radius in which the search should be performed (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
radius: radius in which the search should be performed (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<profile>
<id>8804</id>
<expression>caltrain</expression>
<name>caltrain sf</name>
<created_at>2010-02-02 01:24:44 UTC</created_at>
<deliver_email>1</deliver_email>
<longitude>-122.4194155</longitude>
<latitude>37.7749295</latitude>
<radius>500</radius>
<location> san francisco</location>
<public>1</public>
<category>general</category>
<status>Success: Profile was edited.</status>
</profile>
Method 3: Delete a Profile
URL: http://www.viralheat.com/api/profile/delete?api_key=[*** your api key ***]&profile_id=8805Format: XML
HTTP Method: POST
Requires Authentication: Yes
Parameters:
api_key (mandatory): the authenticated account key.
profile_id (mandatory): specify the profile_id that you want to delete.
profile_id (mandatory): specify the profile_id that you want to delete.
Return Values:
status: If the profile was successfully deleted.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<status>Success: The profile was deleted.</status>
Method 4: List all Profiles
URL: http://www.viralheat.com/api/profile/list_all?api_key=[*** your api key ***]Format: XML
HTTP Method: GET
Requires Authentication: Yes
Parameters:
api_key (mandatory): the authenticated account key.
Return Values:
id: unique id referencing a profile in the system.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
stats_processed_at: The time when statistics were last processed on this profile.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
stats_processed_at: The time when statistics were last processed on this profile.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<profiles>
<profile>
<id>21</id>
<expression>Coca Cola</expression>
<name>Coca Cola</name>
<created_at>2009-04-18 21:58:17 UTC</created_at>
<stats_processed_at>2009-11-03 07:20:50 UTC</stats_processed_at>
<deliver_email>0</deliver_email>
<longitude></longitude>
<latitude></latitude>
<public>1</public>
<category>General</category>
</profile>
<profile>
<id>30</id>
<expression>Pepsi</expression>
<name>Pepsi</name>
<created_at>2009-04-26 22:59:34 UTC</created_at>
<stats_processed_at>2009-11-03 07:21:55 UTC</stats_processed_at>
<deliver_email>0</deliver_email>
<longitude></longitude>
<latitude></latitude>
<public>1</public>
<category>General</category>
</profile>
<profile>
<id>39</id>
<expression>Michelle Obama</expression>
<name>Michelle Obama</name>
<created_at>2009-04-28 01:28:18 UTC</created_at>
<stats_processed_at>2009-11-03 07:21:10 UTC</stats_processed_at>
<deliver_email>0</deliver_email>
<longitude></longitude>
<latitude></latitude>
<public>1</public>
<category>Politics</category>
</profile>
</profiles>
Method 5: List details for a Profile
URL: http://www.viralheat.com/api/profile/details?profile_id=321&api_key=[*** your api key ***]Format: XML
HTTP Method: GET
Requires Authentication: Yes
Parameters:
profile_id (mandatory): id: unique id referencing the profile in the system.
api_key (mandatory): the authenticated account key.
api_key (mandatory): the authenticated account key.
Return Values:
id: unique id referencing a profile in the system.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
stats_processed_at: The time when statistics were last processed on this profile.
total_mentions: Total mentions across all social media sites since the profile was created.
total_facebook: Total Facebook mentions across all social media sites since the profile was created.
total_microblogs: Total twitter mentions across all social media sites since the profile was created.
total_websites: Total website mentions across all social media sites since the profile was created.
total_videos: Total video mentions across all social media sites since the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
name: name of the profile.
expression: search expression used for the profile.
created_at: The time when the profile was created.
stats_processed_at: The time when statistics were last processed on this profile.
total_mentions: Total mentions across all social media sites since the profile was created.
total_facebook: Total Facebook mentions across all social media sites since the profile was created.
total_microblogs: Total twitter mentions across all social media sites since the profile was created.
total_websites: Total website mentions across all social media sites since the profile was created.
total_videos: Total video mentions across all social media sites since the profile was created.
latitude: Latitude of the profile (optional).
longitude: Longitude of the profile (optional).
public: Is the profile is publicly available for social trends.
category: Category of the profile - classified by the user who made the profile.
Categories in Viralheat: General, Brand, Television, Movies, Music, Person, Sports, Politics, Topic.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<profile>
<id>21</id>
<expression>Coca Cola</expression>
<name>Coca Cola</name>
<created_at>2009-04-18 21:58:17 UTC</created_at>
<stats_processed_at>2010-01-24 21:08:03 UTC</stats_processed_at>
<total_mentions>14688</total_mentions>
<total_videos>104</total_videos>
<total_websites>2447</total_websites>
<total_microblogs>12126</total_microblogs>
<total_facebook>11</total_facebook>
<deliver_email>0</deliver_email>
<public>1</public>
<category>General</category>
</profile>
Method 6: List all alerts for a Profile
URL: http://www.viralheat.com/api/profile/alerts?profile_id=21&api_key=[*** your api key ***]Format: XML
HTTP Method: GET
Requires Authentication: Yes
Parameters:
profile_id: id: unique id referencing the profile in the system.
api_key: the authenticated account key.
api_key: the authenticated account key.
Return Values:
id: unique id referencing a profile in the system.
name: name of the profile.
expression: search expression used for the profile.
message: The alert message generated automatically for your profile.
platform: The platform on which the alert was generated.
time: The time at which the alert was generated.
name: name of the profile.
expression: search expression used for the profile.
message: The alert message generated automatically for your profile.
platform: The platform on which the alert was generated.
time: The time at which the alert was generated.
Sample response:
<?xml version="1.0" encoding="UTF-8"?>
<entry>
<profile>
<id>21</id>
<expression>Coca Cola</profile_expression>
<name></name>
</profile>
<alerts>
<alert>
<message>Coca Cola we_are_football is now the top author for the realtime web</message>
<platform>Web</platform>
<time>2009-11-05 10:58:29</time>
</alert>
<alert>
<message>Coca Cola Kenth is now the top author for the realtime web</message>
<platform>Web</platform>
<time>2009-11-05 10:43:51</time>
</alert>
</alerts>
</entry>