Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 3.98 KB

AuditTrailAPI.md

File metadata and controls

91 lines (62 loc) · 3.98 KB

\AuditTrailAPI

All URIs are relative to https://api.segmentapis.com

Method HTTP request Description
ListAuditEvents Get /audit-events List Audit Events

Operation: ListAuditEvents

ListAuditEvents200Response ListAuditEvents(ctx).StartTime(startTime).EndTime(endTime).ResourceId(resourceId).ResourceType(resourceType).Pagination(pagination).Execute()

List Audit Events

Example

package main

import (
    "context"
    "fmt"
    "os"
    api "github.com/segmentio/public-api-sdk-go"
)

func main() {
    startTime := "startTime_example" // string | Filter response to events that happened after this time.  This parameter exists in v1. (optional)
    endTime := "endTime_example" // string | Filter response to events that happened before this time. Defaults to the current time, or the end time from the pagination cursor.  This parameter exists in v1. (optional)
    resourceId := "9aQ1Lj62S4bomZKLF4DPqW" // string | Filter response to events that affect a specific resource, for example, a single Source.  This parameter exists in v1. (optional)
    resourceType := "resourceType_example" // string | Filter response to events that affect a specific type, for example, Sources, Warehouses, and Tracking Plans.  This parameter exists in v1. (optional)
    pagination := *api.NewPaginationInput(10) // PaginationInput | Defines the pagination parameters.  This parameter exists in v1. (optional)

    configuration := api.NewConfiguration()
    apiClient := api.NewAPIClient(configuration)
    token := "<BEARER_TOKEN>"
    ctx := context.WithValue(context.Background(), api.ContextAccessToken, token)
    resp, r, err := apiClient.AuditTrailAPI.ListAuditEvents(ctx).StartTime(startTime).EndTime(endTime).ResourceId(resourceId).ResourceType(resourceType).Pagination(pagination).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AuditTrailAPI.ListAuditEvents``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
        responseErrors := api.UnwrapFullErrors(err)
        if responseErrors != nil {
            for _, responseError := range responseErrors.Errors {
                fmt.Fprintf(os.Stderr, "Full error message: %v\n", *responseError.Message)
            }
        }
    }
    // response from `ListAuditEvents`: ListAuditEvents200Response
    fmt.Fprintf(os.Stdout, "Response from `AuditTrailAPI.ListAuditEvents`: %v\n", resp.GetData())
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListAuditEventsRequest struct via the builder pattern

Name Type Description Notes
startTime string Filter response to events that happened after this time. This parameter exists in v1.
endTime string Filter response to events that happened before this time. Defaults to the current time, or the end time from the pagination cursor. This parameter exists in v1.
resourceId string Filter response to events that affect a specific resource, for example, a single Source. This parameter exists in v1.
resourceType string Filter response to events that affect a specific type, for example, Sources, Warehouses, and Tracking Plans. This parameter exists in v1.
pagination PaginationInput Defines the pagination parameters. This parameter exists in v1.

Return type

ListAuditEvents200Response

Authorization

token

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.segment.v1+json, application/json, application/vnd.segment.v1beta+json, application/vnd.segment.v1alpha+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]