---
title: "Availability Log Object"
slug: "availability-logs"
updated: 2024-04-26T10:16:59Z
published: 2024-04-26T10:16:59Z
canonical: "docs.natterbox.com/availability-logs"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.natterbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Availability Log Object

To report on availability states, you will need report type *Availability Logs*. This object tracks the changes of Availability state so it can be reported on. For more information on availability states, see the [Availability Profiles and States section.](/v1/docs/availability-profiles-and-states)

The nbavs__AvailabilityLog__c object contains a number of fields, which are summarised below.

The most useful fields for reporting are: **Availability State, Availability Profile, Natterbox User, Seconds In State** and **Time**

For examples of reports using the availability logs report type, please see the [Reporting FAQs](/v1/docs/reporting-faqs) section.

| Field | Field Definition | Field Values |
| --- | --- | --- |
| Availability Profile | The availability profile the user has been assigned when the record was made | Lookup (Availability Profile) |
| Availability State | The availability state that the user was in | Lookup (Availability State) |
| AvailabilityLog Name | An Id for the availability state change log | Id |
| Created By | A default Salesforce field used to track who created the record, mostly irrelevant for reporting purposes | Lookup (User) |
| Day | The day of the month that the availability state change happened on. For example if the record was created on the 9 Jan, this field would populate with "9" | Number (1-31) |
| Day of Week | The day of the week | Monday, Tuesday,… |
| Day of Week Numeric | A number corresponding to the day of the week, e.g. Monday = 1, Sunday = 7 | Number (1-7) |
| Day of Week Short | A shortened version of the day of the week, e.g. Monday = Mon, Tuesday = Tue | Mon, Tue, Wed,… |
| External User Id | This field populates with the external id of the Natterbox User | Id |
| Group | The Natterbox Group | Lookup (Group) |
| Hour | The hour of the availability state change, this uses a 24hr clock so 4pm = 16 | Number (1-24) |
| Last Modified By | A default Salesforce field used to track who last edited the record, mostly irrelevant for reporting purposes | Lookup (User) |
| Month Name | The month of the year that the availability state changed happened in | January, February,… |
| Month Name Short | A shortened version of the month of the year that the availability state changed happened in, e.g. October = Oct | Jan, Feb,… |
| Month Name Numeric | A number corresponding with the month of the year, e.g. January = 1, September = 9 | Number (1-12) |
| Natterbox User | The Natterbox User who's availability state changed | Lookup (Natterbox User) |
| Owner | A default Salesforce field populated with who owns the record, mostly irrelevant for this object | Lookup (User) |
| Processed | A checkbox field used by scheduled jobs for checking whether data was received, mostly irrelevant for reporting | True, False |
| Seconds In State | This is the time in *seconds* that the user was in a certain availability state | Number (18,0) |
| Time | This is the time that the availability state change happened | Date/Time |
| User | This is the Salesforce user that had the availability state change. This is the same as the Natterbox User field for most records | Lookup (Salesforce User) |
| Year | This is the year that the availability state changed happened in | Number |

An availability state is a picklist of options within an availability profile to log an agent in and out of a group. This will allow them to take calls from the call queue the group is assigned to.