Harvest fields

31 metrics124 dimensions

Search fields

CLIENT

clients__client_id

Field label	Client ID
Description	The unique ID of the client
Field type	dimension
Data type	string.text.value

clients__client_name

Field label	Client name
Description	The name of the client
Field type	dimension
Data type	string.text.value

clients__currency

Field label	Currency
Description	The currency code associated with the project
Field type	dimension
Data type	string.currency.code

time_entries__client_id

Field label	Client ID
Description	The unique ID of the client associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__client_name

Field label	Client name
Description	The name of the client associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__client_currency

Field label	Client currency
Description	The currency used with the client associated with the time entry
Field type	dimension
Data type	string.currency.code

project_details__client_id

Field label	Client ID
Description	The unique ID of the client
Field type	dimension
Data type	string.text.value

project_details__client_name

Field label	Client name
Description	The name of the client
Field type	dimension
Data type	string.text.value

project_details__currency

Field label	Currency
Description	The currency code associated with the project
Field type	dimension
Data type	string.currency.code

clients__total_hours

Field label	Total hours
Description	The totaled hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

clients__billable_hours

Field label	Billable hours
Description	The totaled billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

clients__none_billable_hours

Field label	None-billable hours
Description	The totaled non-billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

clients__billable_rate

Field label	Billable rate (%)
Description	The percentage of hours that are marked as billable. Formula: Billable hours / Total hours
Field type	metric
Data type	float.number.ratio

clients__billable_amount

Field label	Billable amount
Description	The totaled billable amount for the billable hours
Field type	metric
Data type	float.number.value

DATASOURCE

dataSourceName

Field label	Data source
Description	The name of the source for this data, as listed on supermetrics.com/docs
Field type	dimension
Data type	string.text.value
Destinations	API, Data warehouse

system_metadata.data_source_logins

Field label	Data source logins
Description	The data source login accounts that were used to authenticate against the data source
Field type	dimension
Data type	string.text.json

system_metadata.data_source_login_owners

Field label	Data source login owners
Description	The Supermetrics users that created the data source login connections
Field type	dimension
Data type	string.text.json

PROJECT

projects__project_id

Field label	Project ID
Description	The unique ID of the project
Field type	dimension
Data type	string.text.value

projects__project_name

Field label	Project name
Description	The name of the project
Field type	dimension
Data type	string.text.value

projects__client_id

Field label	Client ID
Description	The unique ID of the client
Field type	dimension
Data type	string.text.value

projects__client_name

Field label	Client name
Description	The name of the client
Field type	dimension
Data type	string.text.value

projects__currency

Field label	Currency
Description	The currency code associated with the client
Field type	dimension
Data type	string.currency.code

time_entries__project_id

Field label	Project ID
Description	The unique ID of the project associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__project_name

Field label	Project name
Description	The name of the project associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__project_code

Field label	Project code
Description	The code of the project associated with the time entry
Field type	dimension
Data type	string.text.value

project_details__id

Field label	Project ID
Description	The unique ID of the project
Field type	dimension
Data type	string.text.value

project_details__name

Field label	Project name
Description	The name of the project
Field type	dimension
Data type	string.text.value

project_details__budget_by

Field label	Budget by
Description	The method by which the project is budgeted
Field type	dimension
Data type	string.text.value

project_details__budget_is_monthly

Field label	Budget is monthly
Description	Option to have the budget reset every month
Field type	dimension
Data type	bool

project_details__cost_budget_include_expenses

Field label	Cost budget include expenses
Description	Option for budget of Total Project Fees projects to include tracked expenses
Field type	dimension
Data type	bool

project_details__is_active

Field label	Is active
Description	Whether the project is active or archived
Field type	dimension
Data type	bool

project_details__is_billable

Field label	Is billable
Description	Whether the project is billable or not
Field type	dimension
Data type	bool

project_details__is_fixed_fee

Field label	Is fixed fee
Description	Whether the project is a fixed-fee project or not
Field type	dimension
Data type	bool

project_details__bill_by

Field label	Bill by
Description	The method by which the project is invoiced
Field type	dimension
Data type	string.text.value

project_details__notes

Field label	Notes
Description	Project notes
Field type	dimension
Data type	string.text.value

projects__total_hours

Field label	Total hours
Description	The totaled hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

projects__billable_hours

Field label	Billable hours
Description	The totaled billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

projects__none_billable_hours

Field label	None-billable hours
Description	The totaled non-billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

projects__billable_rate

Field label	Billable rate (%)
Description	The percentage of hours that are marked as billable. Formula: Billable hours / Total hours
Field type	metric
Data type	float.number.ratio

projects__billable_amount

Field label	Billable amount
Description	The totaled billable amount for the billable hours
Field type	metric
Data type	float.number.value

project_details__budget

Field label	Budget
Description	The budget in hours for the project when budgeting by time
Field type	metric
Data type	float.currency.value

project_details__cost_budget

Field label	Cost budget
Description	The monetary budget for the project when budgeting by money
Field type	metric
Data type	float.currency.value

project_details__hourly_rate

Field label	Hourly rate
Description	Rate for projects billed by Project Hourly Rate
Field type	metric
Data type	float.number.ratio

project_details__fee

Field label	Fee
Description	The amount you plan to invoice for the project. Only used by fixed-fee projects
Field type	metric
Data type	float.currency.value

QUERY

system_metadata.query_date_range_start

Field label	Start date
Description	The start date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_date_range_end

Field label	End date
Description	The end date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_timezone

Field label	Timezone
Description	The timezone that is supplied to the query
Field type	dimension
Data type	string.time.timezone

system_metadata.query_filters

Field label	Filters
Description	All filters used in the query
Field type	dimension
Data type	string.text.json

system_metadata.query_date_start

Field label	Start
Description	When the query was started
Field type	dimension
Data type	string.time.datetime

system_metadata.query_date_end

Field label	End
Description	When the query completed
Field type	dimension
Data type	string.time.datetime

system_metadata.query_duration

Field label	Duration
Description	The duration in seconds of the query
Field type	dimension
Data type	int.duration.seconds

system_metadata.query_accounts

Field label	Accounts
Description	A list of accounts of which the data was pulled from
Field type	dimension
Data type	string.text.json

TASK

tasks__task_id

Field label	Task ID
Description	The unique ID of the task
Field type	dimension
Data type	string.text.value

tasks__task_name

Field label	Task name
Description	The name of the task
Field type	dimension
Data type	string.text.value

tasks__currency

Field label	Currency
Description	The currency code associated with the task
Field type	dimension
Data type	string.currency.code

time_entries__task_id

Field label	Task ID
Description	The unique ID of the task associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__task_name

Field label	Task name
Description	The name of the task associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__task_assignment_id

Field label	Task assignment ID
Description	The unique ID of the task assignment
Field type	dimension
Data type	string.text.value

time_entries__task_assignment_billable

Field label	Task assignment billable
Description	Determines whether the task assignment is billable or not. For example: if set to true, all time tracked on this project for the associated task will be marked as billable
Field type	dimension
Data type	bool

time_entries__task_assignment_is_active

Field label	Task assignment is active
Description	Determines whether the task assignment is active or archived
Field type	dimension
Data type	bool

time_entries__task_assignment_created_at

Field label	Task assignment created at
Description	Date and time the task assignment was created
Field type	dimension
Data type	string.time.datetime

time_entries__task_assignment_updated_at

Field label	Task assignment updated at
Description	Date and time the task assignment was updated
Field type	dimension
Data type	string.time.datetime

time_entries__task_assignment_hourly_rate

Field label	Task assignment hourly rate
Description	Custom rate used when the project is billed by tasks
Field type	dimension
Data type	float.number.value

time_entries__task_assignment_budget

Field label	Task assignment budget
Description	Budget used when the project is budgeted by task
Field type	dimension
Data type	float.number.value

tasks__total_hours

Field label	Total hours
Description	The totaled hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

tasks__billable_hours

Field label	Billable hours
Description	The totaled billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

tasks__none_billable_hours

Field label	None-billable hours
Description	The totaled non-billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

tasks__billable_rate

Field label	Billable rate (%)
Description	The percentage of hours that are marked as billable. Formula: Billable hours / Total hours
Field type	metric
Data type	float.number.ratio

tasks__billable_amount

Field label	Billable amount
Description	The totaled billable amount for the billable hours
Field type	metric
Data type	float.number.value

TEAM

team__user_id

Field label	User ID
Description	The unique ID of the user
Field type	dimension
Data type	string.text.value

team__user_name

Field label	User name
Description	The name of the user
Field type	dimension
Data type	string.text.value

team__is_contractor

Field label	Is contractor
Description	The contractor status of the user associated with the reported hours
Field type	dimension
Data type	bool

team__currency

Field label	Currency
Description	The currency code associated with the task
Field type	dimension
Data type	string.currency.code

team__total_hours

Field label	Total hours
Description	The totaled hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

team__billable_hours

Field label	Billable hours
Description	The totaled billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

team__none_billable_hours

Field label	None-billable hours
Description	The totaled non-billable hours for the given timeframe. If Time Rounding is turned on within Harvest, the hours will be rounded according to your settings
Field type	metric
Data type	float.number.value

team__billable_rate

Field label	Billable rate (%)
Description	The percentage of hours that are marked as billable. Formula: Billable hours / Total hours
Field type	metric
Data type	float.number.ratio

team__billable_amount

Field label	Billable amount
Description	The totaled billable amount for the billable hours
Field type	metric
Data type	float.number.value

TIME

today

Field label	Today
Description	Today's date, e.g. 2017-01-31
Field type	dimension
Data type	string.time.date
Destinations	API, Data warehouse

projects__year

Field label	Year
Description	Year
Field type	dimension
Data type	string.time.year

projects__yearmonth

Field label	Year & month
Description	Year and month
Field type	dimension
Data type	string.time.yearmonth

projects__month

Field label	Month
Description	Month
Field type	dimension
Data type	string.time.month

clients__year

Field label	Year
Description	Year
Field type	dimension
Data type	string.time.year

clients__yearmonth

Field label	Year & month
Description	Year and month
Field type	dimension
Data type	string.time.yearmonth

clients__month

Field label	Month
Description	Month
Field type	dimension
Data type	string.time.month

tasks__year

Field label	Year
Description	Year
Field type	dimension
Data type	string.time.year

tasks__yearmonth

Field label	Year & month
Description	Year and month
Field type	dimension
Data type	string.time.yearmonth

tasks__month

Field label	Month
Description	Month
Field type	dimension
Data type	string.time.month

team__year

Field label	Year
Description	Year
Field type	dimension
Data type	string.time.year

team__yearmonth

Field label	Year & month
Description	Year and month
Field type	dimension
Data type	string.time.yearmonth

team__month

Field label	Month
Description	Month
Field type	dimension
Data type	string.time.month

time_entries__year

Field label	Year
Field type	dimension
Data type	string.time.year

time_entries__year_of_week

Field label	Year of week (Sun-Sat)
Field type	dimension
Data type	string.time.year

time_entries__year_of_week_iso

Field label	Year of week (Mon-Sun)
Field type	dimension
Data type	string.time.year

time_entries__year_month

Field label	Year & month
Field type	dimension
Data type	string.time.yearmonth

time_entries__month

Field label	Month
Field type	dimension
Data type	string.time.month

time_entries__year_week

Field label	Year & week (Sun-Sat)
Field type	dimension
Data type	string.time.yearweek

time_entries__year_week_iso

Field label	Year & week (Mon-Sun)
Field type	dimension
Data type	string.time.yearweekiso

time_entries__week

Field label	Week (Sun-Sat)
Field type	dimension
Data type	string.time.week

time_entries__week_iso

Field label	Week (Mon-Sun)
Field type	dimension
Data type	string.time.weekiso

time_entries__day_of_month

Field label	Day of month
Field type	dimension
Data type	string.time.dayofmonth

time_entries__day_of_week_name

Field label	Day of week (Sun-Sat)
Field type	dimension
Data type	string.time.dayofweek

time_entries__day_of_week_name_iso

Field label	Day of week (Mon-Sun)
Field type	dimension
Data type	string.time.dayofweekiso

time_entries__date

Field label	Date
Field type	dimension
Data type	string.time.date

time_entries__atom

Field label	Datetime
Field type	dimension
Data type	string.time.datetime

project_details__created_at

Field label	Created at
Description	Date and time the project was created
Field type	dimension
Data type	string.time.datetime

project_details__updated_at

Field label	Updated at
Description	Date and time the project was last updated
Field type	dimension
Data type	string.time.datetime

project_details__starts_on

Field label	Starts on
Description	Date the project was started
Field type	dimension
Data type	string.time.date

project_details__ends_on

Field label	Ends on
Description	Date the project will end
Field type	dimension
Data type	string.time.date

team_details__created_at

Field label	Created at
Description	Date and time the user was created
Field type	dimension
Data type	string.time.datetime

team_details__updated_at

Field label	Updated at
Description	Date and time the user was last updated
Field type	dimension
Data type	string.time.datetime

TIME ENTRY

time_entries__time_entry_id

Field label	Time entry ID
Description	The unique ID of the time entry
Field type	dimension
Data type	string.text.value

time_entries__spent_date

Field label	Spent date
Description	Date of the time entry
Field type	dimension
Data type	string.time.date

time_entries__notes

Field label	Notes
Description	Notes attached to the time entry
Field type	dimension
Data type	string.text.value

time_entries__is_locked

Field label	Is locked
Description	Whether or not the time entry has been locked
Field type	dimension
Data type	bool

time_entries__locked_reason

Field label	Locked reason
Description	Why the time entry has been locked
Field type	dimension
Data type	string.text.value

time_entries__is_closed

Field label	Is closed
Description	Whether or not the time entry has been approved via Timesheet Approval in Harvest
Field type	dimension
Data type	bool

time_entries__is_billed

Field label	Is billed
Description	Whether or not the time entry has been marked as invoiced
Field type	dimension
Data type	bool

time_entries__timer_started_at

Field label	Timer started at
Description	Date and time the timer was started if tracking by duration
Field type	dimension
Data type	string.time.datetime

time_entries__started_time

Field label	Started time
Description	Time the time entry was started if tracking by start/end times
Field type	dimension
Data type	string.text.value

time_entries__ended_time

Field label	Ended time
Description	Time the time entry was ended if tracking by start/end times
Field type	dimension
Data type	string.text.value

time_entries__is_running

Field label	Is running
Description	Whether or not the time entry is currently running
Field type	dimension
Data type	bool

time_entries__billable

Field label	Billable
Description	Whether or not the time entry is billable
Field type	dimension
Data type	bool

time_entries__budgeted

Field label	Budgeted
Description	Whether or not the time entry counts towards the project budget
Field type	dimension
Data type	bool

time_entries__billable_rate

Field label	Billable rate
Description	The billable rate for the time entry
Field type	dimension
Data type	float.number.ratio

time_entries__cost_rate

Field label	Cost rate
Description	The cost rate for the time entry
Field type	dimension
Data type	float.number.ratio

time_entries__created_at

Field label	Time entry created at
Description	Date and time the time entry was created
Field type	dimension
Data type	string.time.datetime

time_entries__updated_at

Field label	Time entry updated at
Description	Date and time the time entry was updated
Field type	dimension
Data type	string.time.datetime

time_entries__hours

Field label	Hours
Description	The amount of hours clocked in the time entry
Field type	metric
Data type	float.number.value

time_entries__hours_without_timer

Field label	Hours without timer
Description	The amount of hours clocked in the time entry before the timer was last started
Field type	metric
Data type	float.number.value

time_entries__rounded_hours

Field label	Rounded hours
Description	The amount of hours clocked in the time entry used in summary reports and invoices. This value is rounded according to the Time Rounding setting in your Preferences within Harvest
Field type	metric
Data type	float.number.value

time_entries__entries

Field label	Time entries
Description	The number of time entries
Field type	metric
Data type	int.number.value

USER

time_entries__user_id

Field label	User ID
Description	The unique ID of the user associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__user_name

Field label	User name
Description	The name of the user associated with the time entry
Field type	dimension
Data type	string.text.value

time_entries__user_assignment_id

Field label	User assignment ID
Description	The unique ID of the user assignment
Field type	dimension
Data type	string.text.value

time_entries__is_project_manager

Field label	Is project manager
Description	Determines if the user has Project Manager permissions for the project
Field type	dimension
Data type	bool

time_entries__user_assignment_is_active

Field label	User assignment is active
Description	Determines whether the user assignment is active or archived
Field type	dimension
Data type	bool

time_entries__use_default_rates

Field label	Use default rates
Description	Determines which billable rate(s) will be used on the project for this user when billed by people. When true, the project will use the user's default billable rates. When false, the project will use the custom rate defined on this user assignment
Field type	dimension
Data type	bool

time_entries__user_assignment_budget

Field label	User assignment budget
Description	Budget used when the project is budgeted by person
Field type	dimension
Data type	float.number.value

time_entries__user_assignment_created_at

Field label	User assignment created at
Description	Date and time the user assignment was created
Field type	dimension
Data type	string.time.datetime

time_entries__user_assignment_updated_at

Field label	User assignment updated at
Description	Date and time the user assignment was updated
Field type	dimension
Data type	string.time.datetime

time_entries__user_assignment_hourly_rate

Field label	User assignment hourly rate
Description	Custom rate used when the project is billed by people and default rate is not being used
Field type	dimension
Data type	float.number.value

USERS

team_details__id

Field label	User ID
Description	The unique ID of the user
Field type	dimension
Data type	string.text.value

team_details__first_name

Field label	First name
Description	The first name of the user
Field type	dimension
Data type	string.text.value

team_details__last_name

Field label	Last name
Description	The last name of the user
Field type	dimension
Data type	string.text.value

team_details__email

Field label	Email
Description	The email address of the user
Field type	dimension
Data type	string.text.email

team_details__telephone

Field label	Telephone
Description	The user’s telephone number
Field type	dimension
Data type	string.text.phone

team_details__timezone

Field label	Timezone
Description	The user’s timezone
Field type	dimension
Data type	string.time.timezone

team_details__is_contractor

Field label	Is contractor
Description	The contractor status of the user associated with the reported hours
Field type	dimension
Data type	bool

team_details__is_active

Field label	Is active
Description	Whether the user is active or archived
Field type	dimension
Data type	bool

team_details__roles

Field label	Roles
Description	The role names assigned to this person
Field type	dimension
Data type	string.text.value

team_details__avatar_url

Field label	Avatar URL
Description	The URL to the user’s avatar image
Field type	dimension
Data type	string.text.url

team_details__weekly_capacity

Field label	Weekly capacity
Description	The number of hours per week this person is available to work in seconds, in half hour increments. For example, if a person’s capacity is 35 hours, the API will return 126000 seconds
Field type	metric
Data type	int.number.value

team_details__default_hourly_rate

Field label	Default hourly rate
Description	The billable rate to use for this user when they are added to a project
Field type	metric
Data type	float.number.ratio

team_details__cost_rate

Field label	Cost rate
Description	The cost rate to use for this user when calculating a project’s costs vs billable amount
Field type	metric
Data type	float.number.ratio