GoogleApi.Jobs.V2.Api.Jobs.jobs_jobs_histogram

You're seeing just the function jobs_jobs_histogram, go back to GoogleApi.Jobs.V2.Api.Jobs module for more information.
Link to this function

jobs_jobs_histogram(connection, optional_params \\ [], opts \\ [])

View Source

Specs

jobs_jobs_histogram(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.Jobs.V2.Model.GetHistogramResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:error, Tesla.Env.t()}

Deprecated. Use SearchJobsRequest.histogram_facets instead to make a single call with both search and histogram.

Retrieves a histogram for the given GetHistogramRequest. This call provides a structured count of jobs that match against the search query, grouped by specified facets.

This call constrains the visibility of jobs present in the database, and only counts jobs the caller has permission to search against.

For example, use this call to generate the number of jobs in the U.S. by state.

Parameters

  • connection (type: GoogleApi.Jobs.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.Jobs.V2.Model.GetHistogramRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Jobs.V2.Model.GetHistogramResponse{}} on success
  • {:error, info} on failure