Types

Input and output to Socrata services consists of different types of data elements. Types include primitive types such as strings and integers as well as complex types that are composed of other types.

This section describes Socrata API types in detail.

boolean

A true/false value.

datetime

A date and time value, formatted as seconds since the Unix epoch.

integer

An integer numeric value.

string

A textual value.

User

The User provides data from user profiles. Profile information provided includes:

The user's username and given name.
Public profile details such as hometown, gender, and birthdate.
Their profile image URL (if provided).
Any tags they've specified on their profile.

There are a number of privacy options that control what data is disclosed in a user's profile. A user that has opted not to disclose their real name, for example, will automatically have other private profile details such as city and birthday hidden

Fields:

citystringThe city in which the user resides, if applicable
companystringThe company the user is a part of, if applicable.
countrystringThe country in which the user resides, in ISO 3166 format
createdAtdatetimeThe date on which this user's account was created
createdOnDomainIdintegerThe domain where the user was created on
descriptionstringA description of the user
displayNamestringThe display name the user opts to show.
emailstringThe user's email address (only available for the currently authenticated user)
firstNamestringThe user's first name, if provided
idstringA unique identifier for this User
interestsstringA description of the user's interests
lastLogindatetimeThe date the user last logged in
lastNamestringThe user's last name, if provided
loginstringThe user's login
numberOfFollowersintegerThe number of followers the user has
numberOfFriendsintegerThe number of friends the user has
publicTablesintegerThe number of public datasets this user has created
publicViewsintegerThe number of public views user has created
screenNamestringScreen name does not have to be unique. User can opt to show their full name or screen name depending on their preferences in privacy control.
statestringThe state in which the user resides, if applicable
tagsstring[]An array of user-specified tags for this user
titlestringThe user's title
userLinksUserLink[]External links the user has added to their profile

View

In these Services, "tables" and "views" are interchangibly treated as the same entity, a View. A View includes all of the metadata about a table or view, including descriptive values such as name, description, and tags, as well as structural data like the ViewColumns it contains and any SortBys or ViewFilters that have been specified.

Fields:

columnsViewColumn[]List of columns that the authenticated user has permissions to
descriptionstringThe user-defined description for this view
displayTypestringThe type of display used by this view e.g. map, table, line chart etc.
downloadCountintegerThe number of times this view has been downloaded
flagsstring[]
An array of flags which will include any of the following that apply to this View:
- default This view is a dataset from which other views can be derived
- shared This view has been shared to the current user
grantsGrant[]The visible permissions on this view. If you are the owner of this view, you will see all the permissions you have granted on this view. If you are not the owner, you will see only the public permissions that have been granted on this view.
idstringA unique ID for this view
namestringThe user-specified name for this view
ownerUserThe User who created this this view
rightsstring[]The effective rights the authenticated user has on this view
rowsUpdatedAtdatetimeThe last time data in this view was updated, including changes to the underlying table
rowsUpdatedBystringThe ID of the user who last edited this table
searchStringstringThe full text search string that defines this filtered view
tableIdintegerThe ID of the parent dataset for this view
tagsstring[]An array of owner-specified tags for this view
userTagsUserTag[]An array of user-specified tags for this view
viewCountintegerThe number of times this view has been opened
viewTypestringThe type of the underlying dataset. This can currently be "tabular" for a traditional dataset , "blobby" for a binary blob, or "href" for linked datasets