Type Alias GetIdentificationsSpeciesCountsData

type GetIdentificationsSpeciesCountsData = {
    body?: never;
    path?: never;
    query?: {
        category?: "improving" | "supporting" | "leading" | "maverick";
        current?: true | false | "any";
        currentTaxon?: boolean;
        d1?: string;
        d2?: string;
        hrank?:
            | "kingdom"
            | "phylum"
            | "subphylum"
            | "superclass"
            | "class"
            | "subclass"
            | "superorder"
            | "order"
            | "suborder"
            | "infraorder"
            | "superfamily"
            | "epifamily"
            | "family"
            | "subfamily"
            | "supertribe"
            | "tribe"
            | "subtribe"
            | "genus"
            | "genushybrid"
            | "species"
            | "hybrid"
            | "subspecies"
            | "variety"
            | "form";
        iconicTaxonId?: string[];
        id?: number[];
        idAbove?: string;
        idBelow?: string;
        isChange?: boolean;
        lrank?: | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
        observationCreatedD1?: string;
        observationCreatedD2?: string;
        observationHrank?: | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
        observationIconicTaxonId?: string[];
        observationLrank?: | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
        observationRank?: | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
        observationTaxonActive?: boolean;
        observationTaxonId?: string[];
        observedD1?: string;
        observedD2?: string;
        onlyId?: boolean;
        order?: "desc"
        | "asc";
        orderBy?: "created_at" | "id";
        ownObservation?: boolean;
        page?: string;
        perPage?: string;
        placeId?: string[];
        qualityGrade?: "casual" | "needs_id" | "research";
        rank?:
            | "kingdom"
            | "phylum"
            | "subphylum"
            | "superclass"
            | "class"
            | "subclass"
            | "superorder"
            | "order"
            | "suborder"
            | "infraorder"
            | "superfamily"
            | "epifamily"
            | "family"
            | "subfamily"
            | "supertribe"
            | "tribe"
            | "subtribe"
            | "genus"
            | "genushybrid"
            | "species"
            | "hybrid"
            | "subspecies"
            | "variety"
            | "form";
        taxonActive?: boolean;
        taxonChangeId?: unknown[];
        taxonId?: string[];
        taxonOf?: "identification"
        | "observation";
        userId?: number[];
        userLogin?: string[];
        withoutObservationTaxonId?: string[];
        withoutTaxonId?: string[];
    };
    url: "/identifications/species_counts";
}

Index

Properties

body? path? query? url

Properties

`Optional`body

body?: never

`Optional`path

path?: never

`Optional`query

query?: {
    category?: "improving" | "supporting" | "leading" | "maverick";
    current?: true | false | "any";
    currentTaxon?: boolean;
    d1?: string;
    d2?: string;
    hrank?:
        | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
    iconicTaxonId?: string[];
    id?: number[];
    idAbove?: string;
    idBelow?: string;
    isChange?: boolean;
    lrank?: | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form";
    observationCreatedD1?: string;
    observationCreatedD2?: string;
    observationHrank?: | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form";
    observationIconicTaxonId?: string[];
    observationLrank?: | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form";
    observationRank?: | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form";
    observationTaxonActive?: boolean;
    observationTaxonId?: string[];
    observedD1?: string;
    observedD2?: string;
    onlyId?: boolean;
    order?: "desc"
    | "asc";
    orderBy?: "created_at" | "id";
    ownObservation?: boolean;
    page?: string;
    perPage?: string;
    placeId?: string[];
    qualityGrade?: "casual" | "needs_id" | "research";
    rank?:
        | "kingdom"
        | "phylum"
        | "subphylum"
        | "superclass"
        | "class"
        | "subclass"
        | "superorder"
        | "order"
        | "suborder"
        | "infraorder"
        | "superfamily"
        | "epifamily"
        | "family"
        | "subfamily"
        | "supertribe"
        | "tribe"
        | "subtribe"
        | "genus"
        | "genushybrid"
        | "species"
        | "hybrid"
        | "subspecies"
        | "variety"
        | "form";
    taxonActive?: boolean;
    taxonChangeId?: unknown[];
    taxonId?: string[];
    taxonOf?: "identification"
    | "observation";
    userId?: number[];
    userLogin?: string[];
    withoutObservationTaxonId?: string[];
    withoutTaxonId?: string[];
}

Type declaration

Optionalcategory?: "improving" | "supporting" | "leading" | "maverick"
Type of identification
Optionalcurrent?: true | false | "any"
Most recent ID on a observation by a user
OptionalcurrentTaxon?: boolean
ID's taxon is the same it's observation's taxon
Optionald1?: string
ID created on or after this time
Optionald2?: string
ID created on or before this time
Optionalhrank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
ID taxon must have this rank or lower
OptionaliconicTaxonId?: string[]
ID iconic taxon ID
Optionalid?: number[]
Identification ID
OptionalidAbove?: string
Must have an ID above this value
OptionalidBelow?: string
Must have an ID below this value
OptionalisChange?: boolean
ID was created as a results of a taxon change
Optionallrank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
ID taxon must have this rank or higher
OptionalobservationCreatedD1?: string
Observation created on or after this date
OptionalobservationCreatedD2?: string
Observation created on or before this date
OptionalobservationHrank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
Observation taxon must have this rank or lower
OptionalobservationIconicTaxonId?: string[]
Observation iconic taxon ID
OptionalobservationLrank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
Observation taxon must have this rank or higher
OptionalobservationRank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
Observation's taxon must have this rank
OptionalobservationTaxonActive?: boolean
Observation's taxon is currently an active taxon
OptionalobservationTaxonId?: string[]
Observation taxa must match the given taxa or their descendants
OptionalobservedD1?: string
Observation observed on or after this date
OptionalobservedD2?: string
Observation observed on or before this date
OptionalonlyId?: boolean
Return only the record IDs
Optionalorder?: "desc" | "asc"
Sort order
OptionalorderBy?: "created_at" | "id"
Sort field
OptionalownObservation?: boolean
ID was added by the observer
Optionalpage?: string
Pagination page number
OptionalperPage?: string
Number of results to return in a page. The maximum value is generally 200 unless otherwise noted
OptionalplaceId?: string[]
Observation must occur in this place
OptionalqualityGrade?: "casual" | "needs_id" | "research"
Observation must have this quality grade
Optionalrank?:
    | "kingdom"
    | "phylum"
    | "subphylum"
    | "superclass"
    | "class"
    | "subclass"
    | "superorder"
    | "order"
    | "suborder"
    | "infraorder"
    | "superfamily"
    | "epifamily"
    | "family"
    | "subfamily"
    | "supertribe"
    | "tribe"
    | "subtribe"
    | "genus"
    | "genushybrid"
    | "species"
    | "hybrid"
    | "subspecies"
    | "variety"
    | "form"
ID's taxon must have this rank
OptionaltaxonActive?: boolean
ID's taxon is currently an active taxon
OptionaltaxonChangeId?: unknown[]
Only return identifications that were created as part of the specified taxon change
OptionaltaxonId?: string[]
ID taxa must match the given taxa or their descendants
OptionaltaxonOf?: "identification" | "observation"
Source of the taxon for counting
OptionaluserId?: number[]
Identifier must have this user ID
OptionaluserLogin?: string[]
Identifier must have this login
OptionalwithoutObservationTaxonId?: string[]
Exclude IDs of observations of these taxa and their descendants
OptionalwithoutTaxonId?: string[]
Exclude IDs of these taxa and their descendants

url

url: "/identifications/species_counts"

Type Alias GetIdentificationsSpeciesCountsData

Index

Properties

Properties

Optionalbody

Optionalpath

Optionalquery

Type declaration

Optionalcategory?: "improving" | "supporting" | "leading" | "maverick"

Optionalcurrent?: true | false | "any"

OptionalcurrentTaxon?: boolean

Optionald1?: string

Optionald2?: string

OptionaliconicTaxonId?: string[]

Optionalid?: number[]

OptionalidAbove?: string

OptionalidBelow?: string

OptionalisChange?: boolean

OptionalobservationCreatedD1?: string

OptionalobservationCreatedD2?: string

OptionalobservationIconicTaxonId?: string[]

OptionalobservationTaxonActive?: boolean

OptionalobservationTaxonId?: string[]

OptionalobservedD1?: string

OptionalobservedD2?: string

OptionalonlyId?: boolean

Optionalorder?: "desc" | "asc"

OptionalorderBy?: "created_at" | "id"

OptionalownObservation?: boolean

Optionalpage?: string

OptionalperPage?: string

OptionalplaceId?: string[]

OptionalqualityGrade?: "casual" | "needs_id" | "research"

OptionaltaxonActive?: boolean

OptionaltaxonChangeId?: unknown[]

OptionaltaxonId?: string[]

OptionaltaxonOf?: "identification" | "observation"

OptionaluserId?: number[]

OptionaluserLogin?: string[]

OptionalwithoutObservationTaxonId?: string[]

OptionalwithoutTaxonId?: string[]

url

Settings

On This Page

`Optional`body

`Optional`path

`Optional`query

`Optional`category?: "improving" | "supporting" | "leading" | "maverick"

`Optional`current?: true | false | "any"

`Optional`currentTaxon?: boolean

`Optional`d1?: string

`Optional`d2?: string

`Optional`iconicTaxonId?: string[]

`Optional`id?: number[]

`Optional`idAbove?: string

`Optional`idBelow?: string

`Optional`isChange?: boolean

`Optional`observationCreatedD1?: string

`Optional`observationCreatedD2?: string

`Optional`observationIconicTaxonId?: string[]

`Optional`observationTaxonActive?: boolean

`Optional`observationTaxonId?: string[]

`Optional`observedD1?: string

`Optional`observedD2?: string

`Optional`onlyId?: boolean

`Optional`order?: "desc" | "asc"

`Optional`orderBy?: "created_at" | "id"

`Optional`ownObservation?: boolean

`Optional`page?: string

`Optional`perPage?: string

`Optional`placeId?: string[]

`Optional`qualityGrade?: "casual" | "needs_id" | "research"

`Optional`taxonActive?: boolean

`Optional`taxonChangeId?: unknown[]

`Optional`taxonId?: string[]

`Optional`taxonOf?: "identification" | "observation"

`Optional`userId?: number[]

`Optional`userLogin?: string[]

`Optional`withoutObservationTaxonId?: string[]

`Optional`withoutTaxonId?: string[]