Documentation

This is taking longer than usual. If nothing appears, refresh the page.

Documentation

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!
  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Simple Types - preDefinedSamplePeriodType

Description

Time period to restrict the sample set to

Value Constraints

Only the following values are permitted for this type, passing any other value will generate a validation error.

Allowed Value Mapped Value Description
startofcalendaryear 1 No description provided
startoffinancialyear 2 No description provided
startofcalendarqtr 3 No description provided
startoffinancialqtr 4 No description provided
startofthismonth 5 No description provided
startofthisweek 6 No description provided
startoflastcalendaryear 7 No description provided
startoflastfinancialyear 8 No description provided
startoflastcalendarqtr 9 No description provided
startoflastfinancialqtr 10 No description provided
startoflastmonth 11 No description provided
startoflastweek 12 No description provided
duringlastcalendaryear 13 No description provided
duringlastfinancialyear 14 No description provided
duringlastcalendarqtr 15 No description provided
duringlastfinancialqtr 16 No description provided
duringlastmonth 17 No description provided
duringlastweek 18 No description provided
In This Document