Skip to content

Latest commit

 

History

History
140 lines (101 loc) · 5.81 KB

experienceEndpoints.md

File metadata and controls

140 lines (101 loc) · 5.81 KB
Raw

Experience Endpoints Actions

Details on the various actions that can be performed on the Experience Endpoints resource, including the expected parameters and the potential responses.

Contents

Get

Returns the experience endpoints for an application

result = client.experience_endpoints.get(applicationId: my_application_id)

puts result

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoints.*, or experienceEndpoints.get.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
sortField string N Field to sort the results by. Accepted values are: order, method, route, id, creationDate, requestCount, lastUpdated order order
sortDirection string N Direction to sort the results by. Accepted values are: asc, desc asc asc
filterField string N Field to filter the results by. Blank or not provided means no filtering. Accepted values are: method, route method
filter string N Filter to apply against the filtered field. Supports globbing. Blank or not provided means no filtering. my*route
experienceGroupId string N Filter endpoints to those only in the specified group 575ec8687ae143cd83dc4a97
requestCountDuration string N If set, a count of recent requests is included on each endpoint for the duration requested (milliseconds) 86400000
version string N Return the experience endpoints belonging to this version develop develop
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Endpoints Collection of experience endpoints

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Post

Create a new experience endpoint for an application

result = client.experience_endpoints.post(
  applicationId: my_application_id,
  experienceEndpoint: my_experience_endpoint)

puts result

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Organization, all.User, experienceEndpoints.*, or experienceEndpoints.post.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
experienceEndpoint Experience Endpoint Post Y New experience endpoint information Experience Endpoint Post Example
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
201 Experience Endpoint Successfully created experience endpoint

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found

Stats

Get statistics about endpoint requests

result = client.experience_endpoints.stats(applicationId: my_application_id)

puts result

Authentication

The client must be configured with a valid api access token to call this action. The token must include at least one of the following scopes: all.Application, all.Application.read, all.Organization, all.Organization.read, all.User, all.User.read, experienceEndpoints.*, or experienceEndpoints.stats.

Available Parameters

Name Type Required Description Default Example
applicationId string Y ID associated with the application 575ec8687ae143cd83dc4a97
statGrouping string N Field to group the statistics by. Accepted values are: statusCode, endpointId, version, domain statusCode statusCode
duration string N Duration in milliseconds 86400000 86400000
end string N End of time range in milliseconds since epoch 0 0
resolution string N Resolution in milliseconds 3600000 3600000
versionFilter string N Filters the stats to a particular experience version myVersion
domainFilter string N Filters the stats to a particular experience domain or slug mycustomdomain.com
statusCodeFilter string N Filters the stats to a particular status code 200
endpointIdFilter string N Filters the stats to a particular endpoint 575ec8687ae143cd83dc4a98
losantdomain string N Domain scope of request (rarely needed) example.com

Successful Responses

Code Type Description
200 Experience Endpoint Stats Statistics for endpoint requests

Error Responses

Code Type Description
400 Error Error if malformed request
404 Error Error if application was not found