Response [200 Ok]

Uri /api/v2/user/US-ASEAN!topkeywords
UriDescription User's top keywords
EndpointType UserTopKeywords
Locator UserTopKeywords
LocatorType Object

Timing

Total

cycles 1
objects 0
time 0.27524

Config

{
    "expand_method": "ref",
    "shorturis": false
}

Options

Path

  • /api
  • /v2
  • /user
  • /
  • !topkeywords

Methods

OPTIONS

Permissions
  • Read

GET

Permissions
  • Read

Parameters

GET

Node URI to scope search to
Number of keywords to return

Output Fields

TopKeywords array

JSON

{
    "Request": {
        "Version": "v2",
        "Method": "GET",
        "Uri": "/api/v2/user/US-ASEAN!topkeywords?_accept=text%2Fhtml"
    },
    "Options": {
        "MethodDetails": {
            "OPTIONS": {
                "Permissions": [
                    "Read"
                ]
            },
            "GET": {
                "Permissions": [
                    "Read"
                ]
            }
        },
        "Methods": [
            "OPTIONS",
            "GET"
        ],
        "ParameterDescription": {
            "Integer": "Integer value in the range MIN_VALUE to MAX_VALUE, inclusive",
            "Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null.   Up to a MAX_LENGTH in length."
        },
        "Parameters": {
            "GET": [
                {
                    "Name": "NumKeywords",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Number of keywords to return",
                    "Type": "Integer",
                    "MIN_VALUE": 1,
                    "MAX_VALUE": "POSITIVE_INFINITY"
                },
                {
                    "Name": "NodeURI",
                    "Required": false,
                    "ReadOnly": false,
                    "Default": null,
                    "Description": "Node URI to scope search to",
                    "Type": "Uri",
                    "MAX_LENGTH": "INFINITY",
                    "Locator": []
                }
            ]
        },
        "MediaTypes": [
            "application/json",
            "application/vnd.php.serialized",
            "application/x-msgpack",
            "text/html",
            "text/csv"
        ],
        "Output": [
            {
                "Name": "TopKeywords",
                "Type": "Array",
                "ITEM_TYPE": "Varchar",
                "MIN_COUNT": 0,
                "MAX_COUNT": "INFINITY"
            }
        ],
        "Path": [
            {
                "type": "path",
                "text": "api"
            },
            {
                "type": "path",
                "text": "v2"
            },
            {
                "type": "path",
                "text": "user"
            },
            {
                "type": "singleparam",
                "param_name": "nickname",
                "param_value": "US-ASEAN",
                "param_validator": {}
            },
            {
                "type": "action",
                "text": "topkeywords"
            }
        ]
    },
    "Response": {
        "Uri": "/api/v2/user/US-ASEAN!topkeywords",
        "Locator": "UserTopKeywords",
        "LocatorType": "Object",
        "UserTopKeywords": {
            "TopKeywords": [],
            "Uri": "/api/v2/user/US-ASEAN!topkeywords",
            "UriDescription": "User's top keywords"
        },
        "UriDescription": "User's top keywords",
        "EndpointType": "UserTopKeywords",
        "Timing": {
            "Total": {
                "time": 0.27524,
                "cycles": 1,
                "objects": 0
            }
        }
    },
    "Code": 200,
    "Message": "Ok"
}