smartrecruiters_python_client.AnalyticsApi

All URIs are relative to https://api.smartrecruiters.com/

Method	HTTP request	Description
analytics_applications	GET /analytics/applications	Get the list of applications.
analytics_hiring_team	GET /analytics/hiring-team	Get the list of hiring team members.
analytics_interviews	GET /analytics/interviews	Get the list of interviews.
analytics_job_fields	GET /analytics/job-fields	Get the list of job fields.
analytics_jobs	GET /analytics/jobs	Get the list of jobs.
analytics_positions	GET /analytics/positions	Get the list of job positions.

analytics_applications

ApplicationsReport analytics_applications(date_format=date_format)

Get the list of applications.

Get the list of applications. Fore more comprehensive description see Analytics API and Applications Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()
date_format = 'yyyy-MM-dd'T'HH:mm:ss' # str | Defines response date format (optional) (default to yyyy-MM-dd'T'HH:mm:ss)

try: 
    # Get the list of applications.
    api_response = api_instance.analytics_applications(date_format=date_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_applications: %s\n" % e)

Parameters

Name	Type	Description	Notes
date_format	str	Defines response date format	[optional] [default to yyyy-MM-dd'T'HH:mm:ss]

Return type

ApplicationsReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

analytics_hiring_team

HiringTeamReport analytics_hiring_team()

Get the list of hiring team members.

Get the list of hiring team members. Fore more comprehensive description see Analytics API and Hiring Team Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()

try: 
    # Get the list of hiring team members.
    api_response = api_instance.analytics_hiring_team()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_hiring_team: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

HiringTeamReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

analytics_interviews

InterviewsReport analytics_interviews(date_format=date_format)

Get the list of interviews.

Get the list of interviews. Fore more comprehensive description see Analytics API and Interviews Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()
date_format = 'yyyy-MM-dd'T'HH:mm:ss' # str | Defines response date format (optional) (default to yyyy-MM-dd'T'HH:mm:ss)

try: 
    # Get the list of interviews.
    api_response = api_instance.analytics_interviews(date_format=date_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_interviews: %s\n" % e)

Parameters

Name	Type	Description	Notes
date_format	str	Defines response date format	[optional] [default to yyyy-MM-dd'T'HH:mm:ss]

Return type

InterviewsReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

analytics_job_fields

JobFieldsReport analytics_job_fields()

Get the list of job fields.

Get the list of job fields. Fore more comprehensive description see Analytics API and Job Fields Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()

try: 
    # Get the list of job fields.
    api_response = api_instance.analytics_job_fields()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_job_fields: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

JobFieldsReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

analytics_jobs

JobsReport analytics_jobs(date_format=date_format)

Get the list of jobs.

Get the list of jobs. Fore more comprehensive description see Analytics API and Jobs Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()
date_format = 'yyyy-MM-dd'T'HH:mm:ss' # str | Defines response date format (optional) (default to yyyy-MM-dd'T'HH:mm:ss)

try: 
    # Get the list of jobs.
    api_response = api_instance.analytics_jobs(date_format=date_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_jobs: %s\n" % e)

Parameters

Name	Type	Description	Notes
date_format	str	Defines response date format	[optional] [default to yyyy-MM-dd'T'HH:mm:ss]

Return type

JobsReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

analytics_positions

PositionsReport analytics_positions(date_format=date_format)

Get the list of job positions.

Get the list of job positions. Fore more comprehensive description see Analytics API and Positions Data Service.

Example

from __future__ import print_statement
import time
import smartrecruiters_python_client
from smartrecruiters_python_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: key
smartrecruiters_python_client.configuration.api_key['x-smarttoken'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# smartrecruiters_python_client.configuration.api_key_prefix['x-smarttoken'] = 'Bearer'

# create an instance of the API class
api_instance = smartrecruiters_python_client.AnalyticsApi()
date_format = 'yyyy-MM-dd'T'HH:mm:ss' # str | Defines response date format (optional) (default to yyyy-MM-dd'T'HH:mm:ss)

try: 
    # Get the list of job positions.
    api_response = api_instance.analytics_positions(date_format=date_format)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AnalyticsApi->analytics_positions: %s\n" % e)

Parameters

Name	Type	Description	Notes
date_format	str	Defines response date format	[optional] [default to yyyy-MM-dd'T'HH:mm:ss]

Return type

PositionsReport

Authorization

key

HTTP request headers

Content-Type: Not defined
Accept: application/json; charset=utf-8, text/csv

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

AnalyticsApi.md

Latest commit

History

AnalyticsApi.md

File metadata and controls

smartrecruiters_python_client.AnalyticsApi

analytics_applications

Example

Parameters

Return type

Authorization

HTTP request headers

analytics_hiring_team

Example

Parameters

Return type

Authorization

HTTP request headers

analytics_interviews

Example

Parameters

Return type

Authorization

HTTP request headers

analytics_job_fields

Example

Parameters

Return type

Authorization

HTTP request headers

analytics_jobs

Example

Parameters

Return type

Authorization

HTTP request headers

analytics_positions

Example

Parameters

Return type

Authorization

HTTP request headers