GET apilog

Get data of one apilog.

Parameters

Parameters	Detail
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for GET apilog

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/apilog/{id}

Access Permission

Access to data is available for Enterprise Admins. See Authentication for details on authentication.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/apilog/D2136C62-B65E-40D2-ABD2-873AEF120514

    {
        "log_id": "60511F16-C488-11E2-AFF8-0800271D73CF",
        "client_id": "g3a8010643d34647953f4751a622e9cd",
        "function": "mobileDevice/list (GET)",
        "date_created": "2013-05-24 11:41:18",
        "return_status": "200",
        "query_string": "https://example.brightideatest.com/api3/mobileDevice",
        "request_body": "{\"apiRequest\":\"1\"}",
        "ip": "127.0.0.1",
        "unified_member_id": "395F9B2B-CC23-4B7E-A41D-3FCDFB580322",
        "user_agent": "Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.64 Safari/537.31"
    }

LIST apilog

Get a list of apilogs. Logs are ordered by created date descending by default.

On retrieving large set of data, requester should use pagination parameters such as page and page_size to manage multiple requests.

Parameters

Parameters	Detail
client_id optional	Filter return by client ID Sample value: "11111111-1111-1111-1111-111111111111"
function optional	Filter return by name of the function Sample value: "widget/index (GET)"
date_created optional	Filter return by apilog created date. Response contains all data created within the 24 hours of the specified date Sample value: "12/06/2009"
return_status optional	Filter return by return status. Sample value: "200"
query_string optional	Filter return by query string Sample value: "https://example.brightideatest.com/api3/widget/ideaList"
ip optional	Filter return by IP address. Sample value: "127.0.0.1"
unified_member_id optional	Filter return by unified member ID Sample value: "11111111-1111-1111-1111-111111111111"
user_agent optional	Filter return by user agent **Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.64 Safari/537.31"
page_size optional	Specifies number of records returns per page. Default: 20. Minimum: 1. Maximum: 100 Sample value: 50
page optional	Specifies which page of records to return. Default: 1. Minimum: 1. Maximum: {page_count} Sample value: 5
order optional	A SQL style string that specifies the order the records should return in. Sample value: "date_created ASC". Accepted attributes: "id", "date_created"
format optional	Specifies returned data format Accepted value: "json", "xml"

Resource Information

Authentication: See Access Permission for LIST apilog

HTTP Methods: GET

Request URL Format: https://{api_domain}/api3/apilog

Access Permission

Access to data is available for Enterprise Admins. See Authentication for details on authentication.

Errors

Invalid object ID or you don't have access to this object

Example Request

Method: GET
Header: Authorization=Bearer 85f7b2462570acdde9a458ba6495b8763dcd040c

URL: https://example.brightidea.com/api3/apilog?page_size=2&page=1&return_status=200

{
    "apilog_list": [
        {
            "log_id": "60511F16-C488-11E2-AFF8-0800271D73CF",
            "client_id": "g3a8010643d34647953f4751a622e9cd",
            "function": "mobileDevice/list (GET)",
            "date_created": "2013-05-24 11:41:18",
            "return_status": "200",
            "query_string": "https://example.brightideatest.com/api3/mobileDevice",
            "request_body": "{\"apiRequest\":\"1\"}",
            "ip": "127.0.0.1",
            "unified_member_id": "395F9B2B-CC23-4B7E-A41D-3FCDFB580322",
            "user_agent": "Mozilla/5.0 (Windows NT 6.2; WOW64) AppleWebKit/537.31 (KHTML, like Gecko) Chrome/26.0.1410.64 Safari/537.31"
        },
        {
            "log_id": "D73BBFAC-C487-11E2-AFF8-0800271D73CF",
            "client_id": "app",
            "function": "tag/list (GET)",
            "date_created": "2013-05-24 11:37:28",
            "return_status": "200",
            "query_string": "https://example.brightidea.com/api3/tag?idea_id=386108AA-4569-45D8-9C1F-A79B5D33E041",
            "request_body": "{\"idea_id\":\"386108AA-4569-45D8-9C1F-A79B5D33E041\",\"apiRequest\":\"1\"}",
            "ip": "10.10.2.190",
            "unified_member_id": "5EBEAB6F-B9EB-4360-ACD5-09A674871AA6",
            "user_agent": "Apache-HttpClient/4.1.1 (java 1.5)"
        }
    ],
    "stats": {
        "total": "450696",
        "page_count": 225348,
        "current_page": 1
    }
}