Get activity logs

Returns activity logs

Prerequisites

C#

To get activity logs, first create the instance of CrayonApiClient and get token using the instance.

Then call ActivityLogs.GetAsync() method to get activity logs by passing token and filter.

var client = new CrayonApiClient("https://api.crayon.com/");
var token = client.Tokens.GetUserToken(clientId, clientSecret, userName, password).GetData().AccessToken;
var filter = new ActivityLogFilter() {
    Entity = <entity name>,
    Id = <entity id>,
    SearchDate = <search date>,
    From = <from date>,
    To = <to date>,
    Page = <page number>,
    PageSize = <page size>
};

var result = client.ActivityLogs.GetAsync(token, filter);

Request

Request Syntax:

Method

Request URI

GET

https://api.crayon.com/api/v1/activitylogs

Request parameters:

Name

Type

Required

entity

string

Yes

id

int

Yes

searchDate

DateTimeOffset

No

from

DateTimeOffset

No

to

DateTimeOffset

No

page

int

No

pageSize

int

No

Request Headers:

The following HTTP request headers are supported

Header

Type

Description

Authorization

string

Required. The authorization token in the form Bearer <token>.

Accept

string

Specifies the request and response type, “application/json”.

Content-Type

string

Specifies the media type of the resource, “application/json”.

Request Example:

GET $"https://api.crayon.com/api/v1/activitylogs"
Accept : application/json
Content-Type: application/json
Authorization : Bearer < Token >

Response

If successful, this method returns Activity Logs resource in the response body.

{
    "Entity": "CustomerTenant",
    "Items": [
        {
            "Entity": "ResellerSalesPrice",
            "Id": 206139,
            "ChangedBy": "Crayon",
            "ChangedDate": "2024-11-07T12:11:54.313",
            "ChangedColumn": null,
            "ChangedFrom": null,
            "ChangedTo": null,
            "CustomValues": {
                "Value": "0.00",
                "FromDate": "2024-09-27",
                "CreatedDate": "11/7/2024 12:11:54 PM",
                "SalesPricePriceType": "MarkupOnCost",
                "SalesPriceType": "NCELicense"
            },
            "ChangeType": 2
        },
        {
            "Entity": "ResellerSalesPrice",
            "Id": 206138,
            "ChangedBy": "Crayon",
            "ChangedDate": "2024-11-07T12:11:54.3",
            "ChangedColumn": null,
            "ChangedFrom": null,
            "ChangedTo": null,
            "CustomValues": {
                "Value": "5.00",
                "FromDate": "2023-09-01",
                "CreatedDate": "11/7/2024 12:11:54 PM",
                "SalesPricePriceType": "MarkupOnCost",
                "SalesPriceType": "AzurePlan"
            },
            "ChangeType": 2
        }
    ],
    "TotalHits": 2
}

Response success and error codes:

Each response comes with an HTTP status code that indicates success or failure and additional debugging information. Use a network trace tool to read this code, error type, and additional parameters.

Error Codes

Description

200 Ok

The request has succeeded.

400 BadRequest

Invalid entity id. | Invalid tableName.

401 Unauthorized

The request requires user authentication. If the request already included Authorization credentials, then the 401 (Unauthorized) status code means that authorization has been refused for those credentials. It is a non-retryable error condition.