API Documentation - TrademarkInsight/GetTMGroups

Description

This method retrieves basic data for a trademark group. The name and IDs for the group, target (search engine/region monitored) and keyword are retrieved.

Info

Version:	2
Quota Point Cost:	20

Parameters

Input	Name	Required	Type	Description
	groupids	no	String	The data can be limited to the Group IDs input here. Multiple Group IDs can be entered if they are separated by commas. IDs for all Trademark Groups can be retrieved by leaving this input blank.
	output	no	String	This parameter specifies the output format of the API call. Possible values are XML, CSV or JSON. Default is XML.
	Note: Calling this API method will count against your monthly usage quota

Example Request

http://api.adgooroo.com/v2/TrademarkInsight/GetTMGroups.api?groupids=100500%2c100501%2c100502

Example Output

// XML Output
<?xml version="1.0"?>
<api_result>
  <api_class>TrademarkInsight</api_class>
  <api_method>GetTMGroups</api_method>
  <quota_cost>0</quota_cost>
  <status>SUCCESS</status>
  <message />
  <value>
    <row>
      <groupid>108304</groupid>
      <groupname>newGroup1</groupname>
      <targetid>1</targetid>
      <keywordid>150981</keywordid>
      <keyword>pepsi</keyword>
    </row>
  </value>
</api_result>


// JSON Output
{
  "api_class": "TrademarkInsight",
  "api_method": "GetTMGroups",
  "quota_cost": 0,
  "status": 0,
  "message": null,
  "value": {
    "row": [
      {
        "groupid": 108304.0,
        "groupname": "newGroup1",
        "targetid": 1.0,
        "keywordid": 150981.0,
        "keyword": "pepsi"
      }
    ]
  }
}


// CSV Output
groupid,groupname,targetid,keywordid,keyword
108304,newGroup1,1,150981,pepsi