--- title: "Search Events" url: "https://stage-api-docs.centraldispatch.com/apis/stage-event-api-1-0-0/versions/c1db9b9c-04c4-43e9-9e9c-fe74c2ca0f60/operations/getSearchIntegratorEvents" --- > Full API specification: https://stage-api-docs.centraldispatch.com/apis/stage-event-api-1-0-0/versions/c1db9b9c-04c4-43e9-9e9c-fe74c2ca0f60.md # Search Events `GET` `/integrator-events` Operation ID: `getSearchIntegratorEvents` Search for published events. ## Query parameters - `gt(createdOn,)` (string, optional) - Search for events with created date greater than value, in UTC/ISO 8601 format. - `lt(createdOn,)` (string, optional) - Search for events with created date less than value, in UTC/ISO 8601 format. - `eq(subscriptionId,)` (string, optional) - Search for events with subscription ID equal to value (GUID). - `eq(eventId,)` (string, optional) - Search for events with event ID equal to value (GUID). - `eq(publishStatus,)` (string, optional) - Search for events with publish status equal to value. Allowed values: `SUCCESS`, `FAILED`. - `eq(eventType,)` (string, optional) - Search for events with event type equal to value. Use the `Get Event Types` endpoint to retrieve valid values. - `limit(startingPoint,numberOfResults)` (string, optional) - The maximum number of items to be returned in the response. - `startingPoint` is 1-based integer, default 1. - `numberOfResults` is an integer, default 500, maximum 500. ## Header parameters - `Accept` (string, required) - The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v1+json`. ## Responses - `200` - OK. Successful request. - `400` - Bad Request. Check the request payload. **Scenarios:** - Invalid start or limit values. - Invalid filter parameters. - `401` - Unauthorized. Authentication failed or missing. - `403` - Forbidden. The attempted action is not permitted. - `429` - Too Many Requests. Rate limit exceeded. - `500` - Error. - `503` - Service Unavailable. Temporary service interruption. ## OpenAPI definition ```yaml openapi: 3.0.1 info: title: Event API version: 1.0.0 servers: - url: https://event-api.centraldispatch.com description: Production server paths: /integrator-events: get: tags: - Event summary: Search Events description: Search for published events. operationId: getSearchIntegratorEvents parameters: - name: gt(createdOn,) in: query description: Search for events with created date greater than value, in UTC/ISO 8601 format. schema: type: string example: gt(createdOn,2024-01-19) - name: lt(createdOn,) in: query description: Search for events with created date less than value, in UTC/ISO 8601 format. schema: type: string example: lt(createdOn,2024-02-13) - name: eq(subscriptionId,) in: query description: Search for events with subscription ID equal to value (GUID). schema: type: string example: eq(subscriptionId,50b2863f-c75e-45cb-8d50-b5a975d67865) - name: eq(eventId,) in: query description: Search for events with event ID equal to value (GUID). schema: type: string example: eq(eventId,eec2b82e-29b1-47c3-a391-6da6cce37d7d) - name: eq(publishStatus,) in: query description: "Search for events with publish status equal to value. Allowed values: `SUCCESS`, `FAILED`." schema: type: string example: eq(publishStatus,SUCCESS) - name: eq(eventType,) in: query description: Search for events with event type equal to value. Use the `Get Event Types` endpoint to retrieve valid values. schema: type: string example: eq(eventType,DispatchCreated) - name: limit(startingPoint,numberOfResults) in: query description: |- The maximum number of items to be returned in the response. - `startingPoint` is 1-based integer, default 1. - `numberOfResults` is an integer, default 500, maximum 500. schema: type: string example: limit(1,10) - name: Accept in: header description: The major version of the API to make a request against. This is a custom MIME type that contains `vnd.coxauto.v[#]+`. For example, to request a resource from version 1.x.x of an API, the Accept header should be set to `application/vnd.coxauto.v1+json`. required: true schema: type: string example: application/vnd.coxauto.v1+json responses: "200": description: OK. Successful request. headers: X-CoxAuto-Media-Type: description: Contains the major version and format information. schema: type: string example: coxauto.v1; format=json content: application/json: schema: $ref: "#/components/schemas/SearchIntegratorEventCollection" "400": description: |- Bad Request. Check the request payload. **Scenarios:** - Invalid start or limit values. - Invalid filter parameters. content: application/json: schema: $ref: "#/components/schemas/Errors" "401": description: Unauthorized. Authentication failed or missing. "403": description: Forbidden. The attempted action is not permitted. "429": description: Too Many Requests. Rate limit exceeded. "500": description: Error. content: application/json: schema: $ref: "#/components/schemas/Errors" "503": description: Service Unavailable. Temporary service interruption. security: - Bearer: [] security: - Bearer: [] components: schemas: SearchIntegratorEventCollection: type: object properties: href: type: string description: The URL used to query the current collection of the resource. example: https://event-api.centraldispatch.com/integrator-events?limit(5,1) previous: type: string description: The URL to the previous page of the collection, if available. nullable: true example: https://event-api.centraldispatch.com/integrator-events?limit(4,1) first: type: string description: The URL to the first page of the collection. nullable: true example: https://event-api.centraldispatch.com/integrator-events?limit(1,1) next: type: string description: The URL to the next page of the collection, if available. nullable: true example: https://event-api.centraldispatch.com/integrator-events?limit(6,1) count: type: integer description: The total count of resources in the collection. format: int32 example: 23 limit: type: integer description: The maximum number of items to be returned in the response. format: int32 example: 1 items: type: array items: $ref: "#/components/schemas/SearchEventResponse" description: A collection of records. description: Details of search event. Errors: type: object properties: errors: type: array items: $ref: "#/components/schemas/Error" description: A collection of errors. nullable: true description: An error occurred, and the request could not be completed. SearchEventResponse: type: object properties: subscriptionId: type: string description: The ID of the subscription. format: uuid example: 50b2863f-c75e-45cb-8d50-b5a975d67865 publishStatus: type: string description: The publish status of the event. example: SUCCESS createdOn: type: string description: The creation date and time of the integrator event record, in UTC/ISO 8601 format. format: date-time example: 2024-10-25T19:06:56.85Z eventData: $ref: "#/components/schemas/IntegratorEventResponse" description: Details of an event. Error: type: object properties: code: type: string description: The code used for the issue. nullable: true example: resource.issue_type message: type: string description: A detailed message. nullable: true example: The issue happened because something is wrong. property: type: string description: The property to which the issue is associated. nullable: true example: person properties: type: object additionalProperties: type: string description: Additional properties related to the issue. nullable: true example: firstName: D0nn@ lastName: Sm!th description: Details of an error or issue. IntegratorEventResponse: type: object properties: eventId: type: string description: The ID of the event. format: uuid example: eec2b82e-29b1-47c3-a391-6da6cce37d7d eventType: type: string description: The type of the event. example: DispatchCreated topic: type: string description: The versioned group of events to which the event belongs. example: logistics.cd.dispatch topicVersion: type: string description: The version of the topic. example: "1" timeStamp: type: string description: The timestamp at the time of submission of the event to the event service, in UTC/ISO 8601 format. format: date-time example: 2023-02-28T21:55:38Z environment: type: string description: The environment of the event e.g. production. example: Production partition: type: string description: The data partition for which the data within the event belongs (e.g. 'production-resources' or 'non-production-resources'). example: production-resources correlationId: type: string description: The correlation ID of the event used for logging and tracking. format: uuid example: c0b87c96-1bfb-43f4-956d-c4283ecaab7c headers: type: object description: The headers of the event. nullable: true example: messageId: 157a16f0-503d-4256-ba60-a4876e8eb9bb subscriptionId: 50b2863f-c75e-45cb-8d50-b5a975d67865 marketplaceIds: - "10000" body: description: The body contains a JSON object that is the event contents. example: dispatchId: d159acc0-e89b-12d3-a456-426614174000 dispatchVehicleIds: - b331c130-e89b-12d3-a456-426614174000 description: Details of an event. nullable: true securitySchemes: Bearer: type: http scheme: Bearer ```