Retrieve activity logs | PriceLabs

curl -X POST https://api.pricelabs.co/v1/logs \
     -H "X-API-Key: {{API_KEY}}" \
     -H "Content-Type: application/json" \
     -d '{
  "log_type": "listing",
  "actions": [
    "base_price",
    "min_price"
  ],
  "listings": [
    {
      "listing_id": "lst_123",
      "pms": "airbnb"
    },
    {
      "listing_id": "lst_456",
      "pms": "vrbo"
    }
  ],
  "start_date": "2024-06-01",
  "end_date": "2024-06-30",
  "offset": 0,
  "limit": 50
}'

1	{
2	"data": [
3	{
4	"action": "add_custom_pricing",
5	"action_label": "Added Date Level Override",
6	"log_type": "listing",
7	"entity": {
8	"type": "listing",
9	"listing_id": "lst_100",
10	"name": "Beach House",
11	"pms_name": "airbnb",
12	"pms_display_name": "Airbnb"
13	},
14	"user": {
15	"id": 42,
16	"email": "[email protected]"
17	},
18	"changes": {
19	"start_date": "2024-07-01",
20	"end_date": "2024-07-15",
21	"price": "150",
22	"price_type": "fixed",
23	"min_price": "100",
24	"min_price_type": "fixed",
25	"max_price": "250",
26	"max_price_type": "fixed",
27	"min_stay": 3
28	},
29	"metadata": {
30	"ip_address": "203.0.113.42",
31	"device_type": "web"
32	},
33	"created_at": "2024-06-15T12:00:00Z"
34	}
35	],
36	"pagination": {
37	"offset": 0,
38	"limit": 50,
39	"total": 1
40	}
41	}

Fetches paginated activity logs for the authenticated user. Supports filtering by log type, entity identifiers, actions, team members, and date range.

Request

This endpoint expects an object.

log_typeenumRequired

Entity type to which the logs belong.

actionslist of enumsOptional

Action keys to filter by. Allowed values depend on log_type.

listingslist of objectsOptional

Listing identifiers to filter by. Each entry requires listing_id and pms. Only applicable when log_type is listing.

group_nameslist of stringsOptional

Group names to filter by. Only applicable when log_type is group.

pms_nameslist of stringsOptional

PMS names to filter by. Only applicable when log_type is account.

user_idslist of integersOptional

User IDs to filter logs by specific team members.

start_datedateOptional

Start of date range filter (YYYY-MM-DD). Defaults to 30 days ago.

end_datedateOptional

End of date range filter (YYYY-MM-DD). Defaults to today.

offsetintegerOptional0-1000Defaults to 0

Number of records to skip. Defaults to 0, maximum 1000.

limitintegerOptional1-200Defaults to 50

Number of records to return. Defaults to 50, maximum 200.

Response

Successfully retrieved logs.

datalist of objects

paginationobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

503

Service Unavailable Error

Headers

Request

Response

Errors