Jira Software Data Source

The Jira Software connector enables you to retrieve project management data, issue tracking information, and team collaboration analytics from your Jira Software account. This connector supports retrieving issues, projects, users, and workflow data through the Jira Software REST API.

Jira Software

Configure Using a Template

The following endpoint templates are available for configuring Jira Software data sources. These templates provide pre-configured settings for common API endpoints, making it easy to set up data sources without manual API configuration.

• Select one of the following endpoint templates to configure your data source:

Search for Issues with JQL

Search for Issues with JQL

This endpoint retrieves issues based on a Jira Query Language (JQL) query string with automatic pagination. Use this endpoint to fetch issues that match specific criteria such as status, assignee, date ranges, or custom fields. This endpoint is ideal for complex issue filtering and advanced project analytics.

• Enter your JQL query in the JQL Query field. The JQL query should follow Jira Query Language syntax to filter issues (e.g., project = "PROJECT_KEY" AND status = "Open").
• The endpoint uses pagination with incrementing offset values, starting from 0, and retrieves up to 100 issues per page by default.
• All matching issues are returned in the response, and the connector automatically handles pagination to retrieve all available issues.
• For long JQL queries that may exceed URL length limits in GET requests, use the advanced tab to configure the endpoint as a POST request.

JQL queries can be complex and powerful. Use the advanced tab for long JQL queries that may exceed URL length limits in GET requests. The endpoint supports various JQL operators and functions for advanced filtering. For detailed information about JQL syntax and available operators, refer to the Jira Software REST API search documentation.

Get Issues for Project

Get Issues for Project

This endpoint retrieves all issues for a specific project with automatic pagination. Use this endpoint to fetch all issues within a project, regardless of status or type. This endpoint is ideal for project-specific analytics and issue tracking.

• Enter your project key in the Project Key field. The project key is the unique identifier for your Jira project (e.g., PROJ for a project with key "PROJ").
• The endpoint uses pagination with incrementing offset values, starting from 0, and retrieves up to 100 issues per page by default.
• All project issues are returned in the response, and the connector automatically handles pagination to retrieve all available issues.

This endpoint retrieves all issues for a project regardless of status or type. Use the Search Issues with JQL endpoint for more specific filtering within a project. The project key is case-sensitive and should match exactly as it appears in your Jira instance. For detailed information about the search endpoint, refer to the Jira Software REST API search documentation.

Execute GraphQL Query

Execute GraphQL Query

Execute custom GraphQL queries for advanced data retrieval from your Jira instance. This endpoint is ideal for complex data relationships and custom analytics.

• GraphQL Queries: Use GraphQL syntax for precise data retrieval
• Custom Fields: Access custom fields and complex data relationships
• Advanced Analytics: Retrieve data not available through standard REST endpoints

GraphQL queries provide access to advanced Jira data structures. Ensure you have the necessary permissions and understand GraphQL syntax before using this endpoint.

Manual Configuration

If the pre-configured templates don't meet your needs, you can manually configure custom Jira Software API endpoints.

API Method

Select the HTTP method for your API request:

• GET: For retrieving data (most common for Jira API)
• POST: For complex queries or GraphQL operations

API Endpoint URL

Configure the complete Jira Software API endpoint URL:

1. Base URL: Use your Jira Software instance URL from your credential (e.g., https://yourcompany.atlassian.net)
2. API Path: Specify the Jira API resource you want to access (e.g., rest/api/2/search, rest/api/2/project)
3. Query Parameters: Add any required or optional query parameters

Example URLs:

• https://yourcompany.atlassian.net/rest/api/2/search - Search for issues
• https://yourcompany.atlassian.net/rest/api/2/project - Retrieve project information
• https://yourcompany.atlassian.net/gateway/api/graphql - Execute GraphQL queries

Date/Time Macros

Use dynamic datetime placeholders for flexible endpoint configuration:

• ${start.cron}: Current execution time in cron format
• ${start.iso}: Current execution time in ISO 8600 format
• ${start.unix}: Current execution time as Unix timestamp

Example with date filtering:

https://yourcompany.atlassian.net/rest/api/2/search?jql=updated%20>%20${start.unix}

Lookup-Based Macros

Reference data from other Nexla sources for dynamic endpoint configuration:

• ${lookup.source_name.field_name}: Access specific fields from other data sources
• ${lookup.source_name.field_name[*]}: Access array elements from lookup sources

Path to Data

Specify which part of the Jira API response contains the relevant data:

• JSON Path: Use dot notation for nested data access
  • $.issues[*] - All issues in the response
  • $.projects[*] - All projects in the response
  • $.data[*] - GraphQL query results

Metadata

Preserve contextual information from Jira API responses:

• $.total: Total number of items available
• $.maxResults: Maximum results per page
• $.startAt: Starting index for pagination

Request Headers

Configure additional HTTP headers for API customization:

• Authorization: Automatically handled by Nexla using your Jira Software credential
• Content-Type: Usually application/json for Jira API
• Accept: Specify response format (e.g., application/json)

Example headers:

Content-Type: application/json
Accept: application/json

Testing Your Configuration

After configuring your Jira Software data source:

1. Test Connection: Verify that Nexla can successfully connect to Jira Software
2. Preview Data: Review a sample of the data that will be ingested
3. Validate Schema: Ensure the data structure matches your expectations
4. Check Rate Limits: Monitor Jira's rate limiting to avoid API throttling

Jira Software has rate limits that vary by endpoint and account type. Monitor your API usage in the Jira admin panel to ensure you stay within limits.

Important

Always test your Jira Software data source with appropriate permissions. Ensure your credential has access to the specific Jira projects and issues you're trying to retrieve.