API for cost exports in Focus format

Vipul Kelkar 0

From the cost management documentation for FOCUS data sets

"To access data older than 13 months, you can use the REST API.

Cost and usage (Actual), Cost and usage (Amortized), and Cost and usage (FOCUS): Up to seven years of data."

I understand from this that we can access data older than 13 months up to 7 years through REST API. Can you point to the API documentation which can be used to access data older than 13 months ?

The documentation also says,

You can retrieve up to 13 months of historical data through the Azure portal for all datasets, except for reservation recommendations

However, when I try to configure FOCUS data export for older than 1 month, I get the below error in the portal. Is there some other way to export data for more than 1 month ?

User's image

I have referred to the question here already but the answer doesn't seem to align with the documentation. Can someone please provide an insight into accessing FOCUS and other datasets for older than last 1 month.

Pranay Reddy Madireddy 2,095 Reputation points Microsoft Vendor

2025-01-24T16:16:20.3433333+00:00

Hi Vipul Kelkar

Welcome to the Microsoft Q&A Platform! Thank you for asking your question here.

If you've enabled data export to Data Lake Storage Gen2, you can access historical FOCUS data directly from the storage account, offering greater flexibility for storage and analysis.

https://learn.microsoft.com/en-us/rest/api/cost-management/forecast?view=rest-cost-management-2024-08-01

Make sure you have the right permissions to access the Cost Management API or your Data Lake Storage account.
https://learn.microsoft.com/en-us/rest/api/cost-management/

If you have any further queries, do let us know.

If the answer is helpful, please and "Upvote it".
Vipul Kelkar 0 Reputation points

2025-01-27T05:01:00.2366667+00:00
Hi @Pranay Reddy Madireddy

Thank you for your response, however

The question is how do I get the data into the Data Lake/Storage account because I am able to only configure export for a period of 1 month as indicated in the screenshot. The documentation mentions that all the datasets last 13 months data can be accessed through the Portal.

The documentation that you have pointed to is for the 'Forecast' API. The requirement is to access historic data. As the documentation mentions there is a way to access data older than 13 months through APIs, can you indicate the respective API documentation ?

Awaiting your response, thank you.
Pranay Reddy Madireddy 2,095 Reputation points Microsoft Vendor

2025-01-27T16:10:42.68+00:00

Hi Vipul Kelkar
Welcome to the Microsoft Q&A Platform! Thank you for asking your question here.

According to Microsoft documentation, we can only export data on a monthly basis, and it is not possible to export data for a 13-month period at once.

Thanks,
Pranay
Vipul Kelkar 0 Reputation points

2025-01-28T09:19:05.12+00:00

Hi @Pranay Reddy Madireddy

I understood that the export date can only span a month and not overlap between two different months. Example : export for 28 November 2024-10 December 2024 cannot be configured.
This answers my first question.

For data exports through API, is this the correct API : https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/tutorial-seed-historical-cost-dataset-exports-api
However, I do not see a way to specify the format of data export. How can I export FOCUS format historical data, older than 13 months.
Vipul Kelkar 0 Reputation points

2025-01-28T09:22:22.71+00:00

Hi @Pranay Reddy Madireddy

Thanks for your response. I understood that the export can be configured for a single month and cannot overlap between months. Example : export 28th November 2024 to 10 December 2024 cannot be configured. This answers my first question.

To export historical data through APIs, is this the correct API endpoint ? : https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/tutorial-seed-historical-cost-dataset-exports-api

I cannot see a way to specify the FOCUS format for export
Pranay Reddy Madireddy 2,095 Reputation points Microsoft Vendor

2025-02-05T17:26:04.5533333+00:00

Hi Vipul Kelkar

Use the Azure Portal or API to create a new export. In the API, this involves sending a request to the Cost Management API with details about the export, such as the time period, granularity, and storage location.
https://learn.microsoft.com/en-us/rest/api/cost-management/exports?view=rest-cost-management-2024-08-01Indicate the storage account where the exported data will be stored.

Set the schedule for the export if it is intended to run on a recurring basis.

After the export is finished, retrieve the data from the designated storage location.

If needed, utilize a script or data processing tool to transform the CSV or JSON data into your desired format.

If you have any further queries, do let us know.

If the answer is helpful, please and "Upvote it".
Vipul Kelkar 0 Reputation points

2025-02-06T09:01:42.3666667+00:00

Hi @Pranay Reddy Madireddy ,

I am able to export the 'actual' data set through API calls, however, how do I specify the 'FOCUS' data format in the API request. The documentation does not indicate it.
Vipul Kelkar 0 Reputation points

2025-02-06T09:53:53.9+00:00

Hi @Pranay Reddy Madireddy

I am able to create export through API, however I do not see an option in the documentation to specify FOCUS format in the API request.

I was able to successfully create an export for 'Actual' usage data based on the documentation.

1 answer

Pranay Reddy Madireddy 2,095 Reputation points Microsoft Vendor

2025-02-06T10:12:17.2433333+00:00

Hi @Vipul Kelkar

I'm glad that you were able to resolve your issue and thank you for posting your solution so that others experiencing the same thing can easily reference this! Since the Microsoft Q&A community has a policy that "The question author cannot accept their own answer. They can only accept answers by others ", I'll repost your solution in case you'd like to "Accept " the answer.

Issue:
API for cost exports in Focus format

Solution:
I am able to create export through API, however I do not see an option in the documentation to specify FOCUS format in the API request.

I was able to successfully create an export for 'Actual' usage data based on the documentation.

If you have any other questions or are still running into more issues, please let me know. Thank you again for your time and patience throughout this issue.

Please remember to "Accept Answer" if any answer/reply helped, so that others in the community facing similar issues can easily find the solution.
Please sign in to rate this answer.
Vipul Kelkar 0 Reputation points

2025-02-07T05:13:13.72+00:00

Hi @Pranay Reddy Madireddy

I think my comment got posted without the complete text. I still have a question. How do I specify FOCUS format in the API request ?

Regards,

Vipul Kelkar

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-13T08:46:00.7433333+00:00

Hello Vipul Kelkar,
Have you checked this https://github.com/MicrosoftDocs/azure-docs/blob/main/articles/cost-management-billing/costs/tutorial-improved-exports.md MS Doc related to the focus formats in API.

Vipul Kelkar 0 Reputation points

2025-02-14T05:57:04.6366667+00:00

Hi @Madugula Jahnavi , the documentation does not provide information on how to specify FOCUS format in the export REST API call.

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-17T03:49:54.2933333+00:00

@Vipul Kelkar, can you brief the requirement once to provide you the relevant document or a solution.

Vipul Kelkar 0 Reputation points

2025-02-17T07:19:09.03+00:00

@Madugula Jahnavi I wish to export historical (older than 13 months) cost data in 'FOCUS' format. I have used the following API to export 'actual' data : https://learn.microsoft.com/en-us/azure/cost-management-billing/automate/tutorial-seed-historical-cost-dataset-exports-api

How do I specify FOCUS data in the API request ? Or is there a separate API to export historical FOCUS datasets ?

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-17T07:46:59.7733333+00:00

Vipul Kelkar, Understood. Usually, the exported CSV files will always bind to the FOCUS schema, ensuring consistency with the FOCUS standard. Did you get a chance to refer this MS Doc https://learn.microsoft.com/en-us/azure/cost-management-billing/dataset-schema/cost-usage-details-focus?utm_source=chatgpt.com?

Vipul Kelkar 0 Reputation points

2025-02-18T05:46:12.74+00:00

@Madugula Jahnavi Yes I have tried the API and below are my observations.

According to the documentation, if I specify the TYPE as 'ActualCost', the API fails with the error "Request properties validation failed: Invalid definition type \u0027ActualCost\u0027; valid values: \u0027Usage\u0027".

The API works when I specify the Type as 'Usage'.

The documentation shows an example for exporting data at the billing account scope, however I am trying the export at the Subscription level (my code given below)

Specifying the time duration older than 12 months exports an empty CSV file. Exporting data for Dec 2024 exports the data however NOT in FOCUS format

Seems we are going round in circles. Can you help with the following

How do I export data in FOCUS format using API ?

How do I export data both - newer and older than 12 Months using API ?

"Usually, the exported CSV files will always bind to the FOCUS schema,"

Please help with the pointers on how to achieve this.

Below is the request I tried which failed to export any data. Changing the 'timeperiod' to Dec 2024 worked.

Create and export ----------------------- $Url = "https://management.azure.com/subscriptions/<subscriptionID>/providers/Microsoft.CostManagement/exports/exportwithapi?api-version=2021-10-01" $body = @' { "properties": { "definition": { "dataset": { "granularity": "Daily", "grouping": [] }, "timePeriod": { "from": "2023-12-01T00:00:00.000Z", "to": "2023-12-30T00:00:00.000Z" }, "timeframe": "Custom", "type": "ActualCost" }, "deliveryInfo": { "destination": { "container": "cost", "rootFolderPath": "apicostexport", "resourceId": "/subscriptions/<SubscriptionID>/resourceGroups/Test/providers/Microsoft.Storage/storageAccounts/<stgaccountname>" } }, "format": "Csv", "partitionData": false } } '@ -------------------- RUN the EXPORT -------------------- $Url = "https://management.azure.com/subscriptions/<subscriptionID>/providers/Microsoft.CostManagement/exports/exportwithapi/run?api-version=2021-10-01" $body = @' { "properties": { "definition": { "dataset": { "granularity": "Daily", "grouping": [] }, "timePeriod": { "from": "2022-12-01T00:00:00.000Z", "to": "2022-12-30T00:00:00.000Z" }, "timeframe": "Custom", "type": "Usage" }, "deliveryInfo": { "destination": { "container": "cost", "rootFolderPath": "apicostexport", "resourceId": "/subscriptions/<subscriptionID>/resourceGroups/Test/providers/Microsoft.Storage/storageAccounts/<stgaccountname>" } }, "format": "Csv", "partitionData": false } } '@

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-18T08:57:30.1833333+00:00

Vipul Kelkar, If you're requesting data older than 13 months, the API will not return any results unless you're using an MCA account. And also, the time Period values should be within the retention period. Did you verify the time period stamp?

Vipul Kelkar 0 Reputation points

2025-02-18T09:34:06.55+00:00

"If you're requesting data older than 13 months, the API will not return any results unless you're using an MCA account"

Ok, so where can I find these specifications in the documentation to get a general sense of what is possible, what is not and on which account types- EA, MCA, PAYG etc

Yes, I did specify the time period within the retention period as I have mentioned in my previous comment. However, I can only specify type of cost as 'Usage' and not 'Actual'.

The core question remains, how do I specify the FOCUS format in the API call ?

Is it possible to extract older than 13 month FOCUS data for EA account if you have mentioned it possible to do so for MCA account ?

I am able to configure FOCUS export for a Dev/Test plan subscription through Azure Portal. The documentation says that FOCUS dataset is available for MCA and EA. So what am I missing.

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-18T10:01:54.35+00:00

Vipul Kelkar,

Where can I find these specifications in the documentation to get a general sense of what is possible, what is not and on which account types- EA, MCA, PAYG etc.

Can you check and refer to this MS Doc https://learn.microsoft.com/en-us/azure/cost-management-billing/costs/tutorial-improved-exports#improved-functionality once if this works for you!

Vipul Kelkar 0 Reputation points

2025-02-20T08:35:27.07+00:00

@Madugula Jahnavi thanks, i'll review the documentation

Madugula Jahnavi 0 Reputation points Microsoft Vendor

2025-02-21T04:06:46.4+00:00

Vipul Kelkar, Did you get a chance to work with the provided document! If you have any further questions about this issue, please click on Comment.
Sign in to comment

Use comments to ask for clarification, additional information, or improvements to the question.

Share via

API for cost exports in Focus format

1 answer

Your answer