Search Audits

GEThttps://api.omise.co/audits/search

Search audit logs for account activity. Use this endpoint to find and filter audit records by actor, action type, resource, and time period. Audit logs provide a comprehensive trail of all actions performed on your account.

Request Parameters

Required - 1 fieldRequired Parameters

▼

`scope`STRING(required)

Data type to search. Must be set to "audit" for audit log searches.

Example:"audit"

Default:"audit"

Recommended - 2 fieldsRecommended Parameters

▼

`query`STRING(optional)

Search query text for full-text search. Searches across audit descriptions, actor information, and resource identifiers.

Example:"routing_group"

`filters`OBJECT(optional)

Search filters to narrow results. Available filters include created date, actor email, actor type, auditable type, auditable UID, and verb.

Example:{"created":"2024/01/01..2024/12/31","actor_email":["admin@example.com"]}

Filter Options - 6 fieldsFilter Properties

▼

`filters[created]`DATE-TIME(optional)

Filter by creation date. Supports date ranges using format: YYYY/MM/DD..YYYY/MM/DD

Example:"2024/01/01..2024/12/31"

`filters[actor_email]`ARRAY(optional)

Filter by actor email addresses. Accepts an array of email strings to match against the user who performed the action.

Example:["admin@example.com","user@example.com"]

`filters[actor_type]`STRING(optional)

Filter by actor type. Specifies the type of entity that performed the action.

Example:"user"

Values:user

`filters[auditable_type]`STRING(optional)

Filter by auditable resource type. Specifies the type of resource that was affected by the action.

Example:"routing_group"

Values:routing_group

`filters[auditable_uid]`STRING(optional)

Filter by the unique identifier of the audited resource.

Example:"rgrp_test_5xuy4w91xqz7d1w9u0t"

`filters[verb]`STRING(optional)

Filter by action verb. Specifies the type of action that was performed.

Example:"rules_switched"

Values:rules_switched

Pagination - 2 fieldsPagination Parameters

▼

---

Responses

200

Successful search

Returns a search object containing paginated audit log results in the data array.

Response structure:

• object - String value "search"
• data - Array of audit objects matching the query
• page - Current page number
• per_page - Records per page
• total - Total records matching query
• total_pages - Total number of pages
• filters - Applied search filters
• query - Search query used
• scope - Resource type searched (audit)
• location - API endpoint path

Audit object structure:

• object - String value "audit"
• id - Unique audit log identifier
• actor_email - Email of the user who performed the action
• actor_type - Type of actor (e.g., user)
• auditable_type - Type of resource affected
• auditable_uid - Unique ID of the affected resource
• verb - Action performed
• created_at - Timestamp of the action

400

Bad request

Request validation failed. Check the error message for details.

Common causes:

• Missing required scope parameter
• Invalid scope value (must be "audit")
• Malformed filters object
• Invalid date format in filters
• Invalid enum value for actor_type, auditable_type, or verb

401

Unauthorized

Authentication failed. Invalid or missing API key.

Common causes:

• Missing Authorization header
• Invalid secret key
• Using public key instead of secret key
• Incorrect HTTP Basic Auth format

403

Forbidden

Access denied. Your account does not have permission to access audit logs.

Common causes:

• Insufficient account permissions
• Audit logs not enabled for your account
• API key does not have audit read permissions

5xx

Server error

Server-side error occurred. These are rare but should be handled gracefully.

How to handle:

• Retry the request with exponential backoff
• Check status.omise.co for service incidents
• See Error Handling for detailed guidance

---

Code samples

cURL

curl https://api.omise.co/audits/search \
  -X GET \
  -u skey_test_5xuy4w91xqz7d1w9u0t: \
  -d "scope=audit" \
  -d "filters[created]=2024/01/01..2024/12/31" \
  -d "filters[actor_email][]=admin@example.com" \
  -d "filters[verb]=rules_switched"

Ruby

require 'omise'

Omise.api_key = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = Omise::Search.execute(
  'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
)

Python

import omise

omise.api_secret = 'skey_test_5xuy4w91xqz7d1w9u0t'

search = omise.Search.execute(
    'audit',
    filters={
        'created': '2024/01/01..2024/12/31',
        'actor_email': ['admin@example.com'],
        'verb': 'rules_switched'
    }
)

Node.js

const omise = require('omise')({
  secretKey: 'skey_test_5xuy4w91xqz7d1w9u0t'
});

const search = await omise.search.list({
  scope: 'audit',
  filters: {
    created: '2024/01/01..2024/12/31',
    actor_email: ['admin@example.com'],
    verb: 'rules_switched'
  }
});

PHP

<?php
define('OMISE_SECRET_KEY', 'skey_test_5xuy4w91xqz7d1w9u0t');

$search = OmiseSearch::execute([
    'scope' => 'audit',
    'filters' => [
        'created' => '2024/01/01..2024/12/31',
        'actor_email' => ['admin@example.com'],
        'verb' => 'rules_switched'
    ]
]);

Java

Client client = new Client.Builder()
    .secretKey("skey_test_5xuy4w91xqz7d1w9u0t")
    .build();

SearchResult<Audit> search = client.search()
    .scope(SearchScope.Audit)
    .filter("created", "2024/01/01..2024/12/31")
    .filter("actor_email", Arrays.asList("admin@example.com"))
    .filter("verb", "rules_switched")
    .send();

C#

var client = new Client("skey_test_5xuy4w91xqz7d1w9u0t");

var search = await client.Search.Execute(new SearchRequest
{
    Scope = "audit",
    Filters = new Dictionary<string, object>
    {
        { "created", "2024/01/01..2024/12/31" },
        { "actor_email", new[] { "admin@example.com" } },
        { "verb", "rules_switched" }
    }
});

Go

client, _ := omise.NewClient(
    "pkey_test_5xuy4w91xqz7d1w9u0t",
    "skey_test_5xuy4w91xqz7d1w9u0t",
)

search, _ := client.Search(&operations.SearchOptions{
    Scope: "audit",
    Filters: map[string]interface{}{
        "created":     "2024/01/01..2024/12/31",
        "actor_email": []string{"admin@example.com"},
        "verb":        "rules_switched",
    },
})

---

Error and result codes

Common Filter Patterns

Filter Syntax	Description	Example
filters[created]=date..date	Date range	2024/01/01..2024/12/31
filters[actor_email][]=value	Email array	admin@example.com
filters[verb]=value	Exact match	rules_switched
filters[auditable_type]=value	Resource type	routing_group

Available Filters

Filter	Type	Description
created	date-time	Filter by action timestamp
actor_email	array	Filter by user email(s)
actor_type	string	Filter by actor type (user)
auditable_type	string	Filter by resource type (routing_group)
auditable_uid	string	Filter by resource identifier
verb	string	Filter by action type (rules_switched)

---

🔑API Credentials

▼

Try it out

Required - 1 fields

▼

scope(Required)

Recommended - 3 fields

▼

Additional - 6 fields

▼

Your IP: ...Loading...