Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Frequency Histograms

Parameters

  • Location
    • state
    • county
    • BCR
    • my locations (eBird-only)
    • hotspot (eBird-only)
  • Period
    • What portion of year?
    • Which years?
  • Species
    1. all present at location
    2. short list
    3. single species

parameter group

description

parameter name

values

example

default

location

exactly one location parameter is required

subnational1

eBird standard subnational1 codes

US-FL

n/a

 

 

country

2-letter ISO codes

CA

n/a

 

 

bcr

integers 1-64?

14

n/a

 

 

subnational2

eBird standard subnational2 codes

 

n/a

 

 

 

 

 

 

period

  • period parameters are optional
  • if specified, both must be provided
  • constraint beginYear <= endYear

 

 

 

 

 

 

beginYear

defines beginning of period of interest, in YYYY format

2000

????

 

 

endYear

defines end of period of interest, in YYYY format

2000

????

 

 

 

 

 

 

collection

  • defines dataset of interest
  • required

collection

AKN collection codes, eBird project IDs; initially there will be no away to request the entirety of AKN data as a collection

EBIRD_PR

n/a

 

 

 

 

 

 

species

  • defines species of interest
  • optional

species

either "all" or scientific name of single species of interest; we will handle lists of species at a later date

Sialia sialis

all

 

 

 

 

 

 

output

  • defines form of output

output

"f" = returns frequency (float, 0.0-1.0)
"c" = returns category (integer, 1-5)
"i" = returns image for single species; valid only when single species is requested; implemented at a later date

f

f

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Supporting web services needed

  • Species list
  • Species search
  • Collection codes list
  • Subnational2Code list and/or search

CSV Format Output (or tab delimited)

...